ufosc / VisualNovel

A visual novel to help new programmers learn about various languages and frameworks in a fun way
GNU General Public License v3.0
32 stars 63 forks source link

Bytes of Love

standard-readme compliant GitHub issues GitHub

banner

A visual novel developed by the UF Open Source Club. Started in the Fall 2023, this game is built and maintained by club members.

For the latest development version, download here: Download Bytes of Love

Table of Contents

Team Members

The project is currently maintained by the UF Open Source Club, can be contacted via Discord.

The lead team members in charge of the project are as follows. Reach out to any of them via Discord with questions regarding the project. Click the names of the Tech Leads if you wish to send an email as your preferred form of communication.

Tech Leads:

Lead Contributors:

Lead Mathew:

Installation

Prerequisites

This project requires Python and the Ren'Py SDK to run. You can install them from here:

Setup

Once you have downloaded the Ren'py SDK, extract it into your project directory.

Now, you can fork the repository and clone it into the root directory of the SDK using this command using ssh or http:

In the renpy.8.1.1-sdk folder.

SSH

    git clone git@github.com:ufosc/VisualNovel.git 

HTTP

    git clone https://github.com/ufosc/VisualNovel.git 

You can start up the Ren'Py launcher by launching renpy.exe in the renpy.8.1.1-sdk directory. If you are a Mac user, launch via renpy instead of renpy.exe. Once the launcher opens, the project should show up in the projects tab as UFOSC.

If the project is not showing up you need to set the project directory manually. This is done by navigating to preferences located under the Launch Project button on the botton right.

Then under Project Directory, update the project directory to renpy-8.1.1-sdk/VisualNovel or the parent folder that UFOSC is located in.

The program and games file can be edited in the scripts.py file in the UFOSC folder.

Resources

Here are some additional resources for using and contributing to the project:

Contributing

All contributions are welcome and appreciated, so long as they adhere to the license.

ALL Script Contribution/Style Guide questions should refer to style guide.

To contribute, check out the issues for anything that you think you can work on. As always, reach out to any of the Tech Leads or Lead Contributors for permission to tackle the issue before working on it. Feel free to ask for any help in setting up the coding environment and for any clarification on issues.

Review the Bytes of Love Documentation for any information regarding the game's ideas, progress, and next steps. For edit access, reach out to Nicolas Valiente for approval; you must request the access in person during Casual Coding sessions.

License

AGPL 2.0