Volcaldera-Ashfall-Teaser-Public
This is the public hub for code/issues/PR's for the Volcaldera Ashfall Teaser.
Information regarding how to set up the full game as a Ren'Py project using the Teaser can be found below.
Building
There are two options for building dependong on your preference:
-
Ren'Py SDK - For being able to launch the project as a game and/or make personal distributions. Good for computerlets/ease of use. Has debugging features and a bit more options. Requires a bit more setup for Android building. Will not include workshop support by itself.
-
RenKit - For accurate compilation. Good for automation/terminal users. Dead simple setup, auto downloads almost all required files for building distributions, including the SDK and most Android stuff. Allows CLI interfacing with Ren'Py to launch projects. Includes workshop support via the patching functionality.
BUILDING WITH THE SDK
- Download the Ren'Py 8.5.2 SDK depending on your system
- Extract the .zip/.bz2/.dmg or get it through your package manager and run the SDK.
- Clone this repo - Or if you don't use Git, click the '...' button near the topright of this page and click 'Download ZIP' - and place it within the Ren'Py SDK or to a directory of your choosing.
- Launch the SDK and set the projects path to the folder containing your repo. Make sure the project is selected within the projects list.
- Optionally, click 'Launch Project' to launch the game in developer mode - which is the same as normal play but grants access to several dev tools - before building.
- When you're ready to distribute, click 'Build Distributions' and select your appropriate OS's. Click 'Build' and your builds will appear beside your cloned folder.
BUILDING WITH RENKIT
- Download RenKit 6.1 depending on your system
- Extract the .zip/.xz or get it through your package manager.
- Clone this repo - Or if you don't use Git, click the '...' button near the topright of this page and click 'Download ZIP' - and place it somewhere you can access.
- Edit the
renconstruct.tomlfile in the root of the project files to fit your needs like which distributions you want to build. - (OPTIONAL) If you want to include building for Android, you'll need to install JDK 21 as renconstruct can't do that automatically. Read up the Ren'Py documentation for info on how.
- Run
renconstruct.exewith the following command:
renconstruct build "<path to demo project files>" "<path to outputted distributions>" -c "<path to demo project files>/renconstruct.toml"
This will start the build process and outputs the game to whatever path you set your distributions to.
More information on the build process can be found here.
Information relating to building for Android can be found here here as well. Information regarding RenKit and it's documentation can be found on its github page
Libraries Used
Licenses within this game
All code, including the story and fonts, is licensed under the AGPL v3. All audio and image/video assets are licensed under CC BY-SA, with the exception of a few that are CC BY, listed in the LICENSE file.
