Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
V31
Sep 14, 2019
bin
May 30, 2020
V31
Sep 14, 2019
Nov 22, 2020
Aug 15, 2020
V31
Sep 14, 2019
Jun 22, 2017
V31
Sep 14, 2019
V31
Sep 14, 2019

readme.md

Build Status

ALttP VT Randomizer

First and foremost, big thanks to Dessyreqt, Christos, Smallhacker, and Karkat for their work.

Without their work none of this would even be remotely possible.

Installing dependencies

You will need Composer for the Laravel Dependency. Once you have that, run the following

$ composer install

Running from the command line

To generate a game one simply runs the command:

$ php artisan alttp:randomize {input_file.sfc} {output_directory}

For help (and all the options):

$ php artisan alttp:randomize -h

Running the Web Interface

Database setup

Create a new mysql database for the randomizer (see mysql documentation for how to do this, you'll need to install mysql server if it's not installed already)

Run the following command to create a new config for the app

$ cp .env.example .env

Then modify .env with appropriate username, password, and database name. Change the db connection to mysql Example:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=randomizer
DB_USERNAME=foo
DB_PASSWORD=bar

Then run the following commands to setup the app configuration

$ php artisan key:generate
$ php artisan config:cache

p.s. If you update the .env file then you'll need to run the config:cache command to pick up the new changes.

Now run the db migration command:

$ php artisan migrate

Web server setup

You will need to build assets the first time (you will need NPM to install the javascript dependencies).

$ npm install

Next generate the Laravel-vue include file with

php artisan vue-i18n:generate

And finally

$ npm run production

Once you have the dependencies installed. Run the following command then navigate to http://localhost:8000/.

$ php artisan serve

Running tests

You can run the current test suite with the following command (you may need to install PHPUnit)

$ phpunit

Bug Reports

Bug reports for the current release version can be opened in this repository's issue tracker.

Please do not open issues for bugs that you encounter when testing a development branch.

You can’t perform that action at this time.