-
Notifications
You must be signed in to change notification settings - Fork 11
Contribute
The development is fairly layered. The following roles exists in the project as of now, see dungeon generation to to better understand what they do.
- Dungeon generation designer/developer
- Room generation designer/developer
- Room component designer
- Graphical asset manager/designer
- Storyboard developer/designer
- Tester
Basically we welcome game designers, graphic designers and lua developers.
Read up on our development.
Solarus Games' official video tutorials to the quest editor is also a good start:
http://wiki.solarus-games.org/doku.php?id=video_tutorial
Component design guidelines is also a good start if you aim to design components.
Certain generation and gameplay variables can be set by manipulating the settings.dat. See settings.
The git repository is at https://github.com/Legofarmen/tunics
The repository only contains the data folder, you need to add the solarus engine yourself.
To clone the repository use: git clone https://github.com/Legofarmen/tunics.git
Get git for windows here: http://git-scm.com/download/win
Learn git here: http://git-scm.com/book/en/v2/Getting-Started-About-Version-Control
If you are working in the quest editor, close the editor before pulling to avoid project_db.dat merge conflicts.
Message should describe the purpose of the change in imperative form; the message should describe what the changes do.
If your commit message cannot fit on one line, use the first line to write a summary followed by an empty line followed by more lines with the full message, as per github standard.
This section outlines the recommended basic workflow for contributing to the official repository of Tunics!, complete with git cheat sheet.
Preferably in the projects github issue tracker: https://github.com/Legofarmen/tunics/issues
Wait for buy-in and discussion of your idea.
Smaller enhancement can be submitted for review as pull requests if the are polished and tested.
First, create your own fork of https://github.com/Legofarmen/tunics.git.
Find out your SSH clone URL - henceforth referred to as 'YOUR_FORK'.
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
git clone YOUR_FORK
cd tunics
git status
git remote add upstream https://github.com/Legofarmen/tunics.git
git remote set-url --push upstream YOUR_FORK
git fetch --all
git remote -v
git branch --set-upstream-to=upstream/master master
git branch --track develop upstream/develop
git branch -vv
git fetch upstream
git checkout -b YOUR_TOPIC_BRANCH upstream/develop
git add FILES
git commit
Repeat as needed.
git fetch upstream
git rebase upstream/develop
After any manual conflict resolution do this:
git add UPDATED_FILES
git rebase --continue
git push --set-upstream origin YOUR_TOPIC_BRANCH
- Go to your fork.
- Select YOUR_TOPIC_BRANCH.
- Create pull request with:
- base fork:
Legofarmen/tunics - base:
develop - your fork: your fork
/tunics - compare:
YOUR_TOPIC_BRANCH - Title: A descriptive title
- Description: A summary of the changes
- base fork:
Maintainers of Legofarmen/tunics give feedback and possibly further instructions.
git add FILES
git commit
git push
Maintainers of Legofarmen/tunics give feedback and possibly further instructions.
git fetch --all
git branch -vv
git merge --ff-only master upstream/master
git merge --ff-only develop upstream/develop
git push origin master
git push origin develop
git push --delete origin BRANCH
git checkout develop
git branch -d BRANCH
We are lacking an IRC channel at the moment. Communication mostly occurs through github issues.