Skip to content

video-game-randomizers/rando-list

Repository files navigation

The BIG List of Video Game Randomizers

About

This repository contains the source code for The BIG List of Video Game Randomizers, a community project created and originally published in 2016 by Guillaume Fortin-Debigaré.

The project has been continuously maintained by him based on countless contributions by the community over the years, and is now maintained directly via open-source contributions.

How to contribute

You can request updates to the list either by submitting an issue with the Submit New Randomizer template, or in the #list-submissions channel in the Discord.

Pull requests from the public are very welcome - if you wish to become a maintainer or need help contributing, please join the Discord and see #list-maintenance. We recommend using VSCode if you wish to edit the series YAMLs, as the workspace contains configuration to use our schema by default.

If you really want to help maintain the list, go through the submissions in our Issues list and the submissions in Discord. Make pull requests to add/update the randomizers to the yml files. Make sure the description of the pull request includes a link to the issue or Discord message so we know to mark it as done.

The available YAML properties are listed in the schema file but mostly you can just figure it out by reading the existing files. There is an optional property for opensource that is pretty common, see Deus_Ex.yml for a simple example.

Code structure

The site's Jekyll/Liquid templates are stored in src and src/_includes/, while the data is stored as a YAML file per game series in src/series/.

Note that all games must be in a series; if a game does not belong to a series, give the series the same name as the game.

Building

If you want to do full builds locally, you must install Jekyll - if on Windows you probably want to use WSL. You also need to do pip install -r requirements.txt.

  • python validate-schema.py
  • cd src
  • bundle install to install dependencies
  • bundle exec jekyll serve

This will host the site on http://127.0.0.1:4000/rando-list/.

You can also run the Jekyll Build & Deploy GitHub action & download the outputted artifact if you do not wish to install Jekyll locally.

Releases

No releases published

Packages

No packages published

Contributors 12