VOCC is a web-based image editor focused on Game Boy Advance Development.
Visit the website to use the application. You won't need to download anything or install any dependencies, all you need is a web browser.
Please view the release notes for a summary of the most recent changes and known issues.
By default, the VOCC website should be able to be used while offline. In some certain cases, you can "install" a shortcut to the application to your operating system.
If you are using a modern web browser that supports progressive web applications (PWAs), then when you visit the website you should see a button that says "Install" in the title bar. Clicking this button installs the application locally and you can use it offline. Tested on Chrome, Chromium, and Brave. Firefox does not support installing PWAs.
If you're using a different browser that supports service workers, offline use should still work but you won't be able to install the application.
The recommended way to develop on Windows is to use the Windows Subsystem for Linux and then develop as if you were on a Linux machine.
I also recommend that you use Visual Studio Code as your text editor on Windows, as it provides first-class support for TypeScript and has the super handy Remote - WSL extension.
Coming soon (mostly the same as Linux though, just install Node without the package manager, or use Homebrew).
First, make sure your Linux installation is fully up to date (on Ubuntu, run sudo apt update && upgrade
). Then, complete the following steps:
node -v
and npm -v
. If NPM isn't working, try starting a new terminal window/tab after installing Node.npm i -g yarn
(you may need to use sudo
)git clone https://github.com/lbussell/vocc
cd vocc
yarn
yarn start
If you notice a bug, please create an issue!
If you're looking to contribute code, please look at the Projects tab to see some of the ongoing development for this project and find an issue to look at.
See https://help.github.com/en/articles/configuring-a-remote-for-a-fork to configure your own fork of this repo.
To make changes:
master
branchmaster
branch, fetch the newest changes from this repo's master
branch, and then uploads it to your fork's master
branch.git checkout master
git fetch upstream
git pull upstream master
git push origin master
git checkout -b [branch name]
git push -u origin [branch name]
Commit your changes
Once you have made changes and they work, you can move the modified files to
the staging area with git add
, and then commit your changes with git commit. git add path/to/updated/file
git commit -m "change file"
Note: git add .
adds all changed files in the current directory (including all
children directories).
Another note: When committing files, use present tense verbs. Ex. “add player class” “implement basic GUI” etc.
Publish your changes
To push your changes to your fork, use git push
. From there, you can create a pull request to this repository to get your changes reviewed and potentially merged.
Authors: Logan Bussell, Bennett Hillier, Rosie Blair, Jacob Lambert, John Beckner