This guide is meant for new team members to orient themselves and get started working on Kandria. In order to get set up and ready for development, please follow the setup guide. If you need information on the project structure and organisation, see the relevant sections below. Please also regard the guidelines for contributions.
Before you get started, please send Shinmera your GitHub username so he can add you to the project's contributors list and allow you commit access. Also make sure you have a Git client that you're familiar with and which supports git-lfs.
Unlike many other game projects, Kandria uses a custom engine and is written in Common Lisp. This means that unfortunately the setup is a bit more involved, but not by much. In order to ease setup, a custom development environment has been put together. You can download it from here:
If you're already familiar with Emacs, you might want to set up a native development environment instead of using Portacle. In that case, contact Shinmera for advice. If not, carry on.
First you should update the Kandria sources. Kandria should already be cloned within the development environment package at
projects/kandria. There are a few other directories in the projects folder that contain other, necessary libraries. Please use Git in whatever fashion you find comfortable to pull all of the repositories within the projects directory and ensure they're up to date.
Once that's done, please start
Portacle (the development environment). It should greet you with a screen similar to this:
In the section with the
CL-USER> prompt, type
(ql:quickload :kandria) (or copy and paste it with
Ctrl+Y.) This will compile and load the game. It'll take a while the first time you do it. After that, try starting the game with
(kandria:launch). If that opens the game successfully, then, congratulations! You're all set up and ready for development! If you encounter a problem at any point, such as an error prompt opening up, contact Shinmera to help with the debugging.
For further help with the IDE, press
Ctrl+H H within the IDE. This should bring up a help document that explains the terminology, keyboard shortcuts, and more.
The source tree is divided up as follows:
Game source files. Unless otherwise noted, other directories contain source subsystems.
Binary deployment target directory. When the game is built as an executable, the output lands here.
Assets like textures, tiles, sprites, sounds, etc. including raw source files (ase, etc.)
Documentation and documents related to the project and its website. This document should be in this directory.
A mood board with reference images and videos for the art direction.
Documentation for beta testing.
Documentation on the combat system that the game employs.
The overall game design document that outlines the game's mechanics, story, and planning.
Documentation on the dialogue format and syntax.
Documentation on the in-game editor and how to use its features.
lisp crash course.mess
A short introduction to Lisp syntax and usage related to Kandria.
Collection of tidbits on setting, technology, etc. lore.
Design pillars document with the most important parts at a glance.
Documentation on the behaviour and capabilities of the quest system.
Source files related to publishing, packaging, and archiving game releases.
Source files for levels, quests, and dialogue.
Source files to describe the initial state of the game when loading a new game.
Source files for every "region" in the game – meaning level data.
Source files for every quest in the game. Each quest should have its own directory.
For instant communication please use Discord. The rest of the project management happens through a Google doc. Please have a look at it here:
The doc contains sheets with current todo items, ideas for the future, and details on these tasks. The todo items should be sorted with the more important ones at the top. Once you complete an item, please check it off and move it to the bottom. For ideas, please just throw them into the ideas sheet and discuss them over Discord. If it turns out there's time available and the idea seems good, it can be moved over to the todo section.
The animations sheet is a more detailed overview of the pixel animations that need to be done for the various characters and enemies in the game. More will be added there as necessary. Animations need to first be sketched, then properly animated, and finally integrated into the game by filling in combat animation data and triggering it on appropriate events.
Users can submit feedback for Kandria through an automated system. The resulting reports end up on a server that manages them. In order to view these reports, please create a TyNET account and inform Shinmera of your account name so that he can give you access. Once an account has been created, you can view reports here:
Additionally, the mailing list system is also hosted on TyNET, and can be found here:
When contributing to the project please use a separate branch and do not commit directly to
master. You may either use per-feature branches or just a singular branch for all of your work. When you are done with a task and would like to get feedback on it, let the rest of the team know so they can go and check it out.
When pulling, please use the rebase strategy whenever possible (
git pull --rebase). If you have trouble with Git in one way or another, contact Shinmera for advice.
If you need to run the game and something's not working, please ensure that all of the repositories in the
projects/ folder are up-to-date. The other projects are support libraries and may occasionally receive updates as well as the development progresses.