README.md

UF Visual Novel

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

Table of Contents

• UF Visual Novel
  • Table of Contents
  • Installation
    • Prerequisites
    • Setup
  • Usage
  • Resources
  • Maintainers
  • Contributing
  • License

Installation

Prerequisites

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

• Python (Latest): https://www.python.org/downloads/
• Ren'Py (8.1.1 or greater): https://www.renpy.org/latest.html

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 [email protected]:user/VisualNovel.git 

HTTP

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

Usage

You can start up the Ren'Py launcher by launching renpy.exe in the renpy.8.1.1-sdk directory. 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:

• Script Writing
• Ren'py Cheat Sheet
• Ren'Py Documenation
• Mood Board
• Miro Board

Maintainers

Maintained by the UF Open Source Club, can be contacted via Discord

Current Maintainers:

• Nicolas Valiente @nickv779
• Mathew Alangadan @malangadan
• Anton Salvador @antoncsalvador

Contributing

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

License

AGPL 2.0