Git Product home page Git Product logo

randstalkergui's Introduction

Continuous Integration GitHub tag License

RandstalkerGUI

GUI for the Landstalker randomizer

Randstalker

Randstalker is a randomizer for the famous Megadrive / Genesis classic "Landstalker : The Treasure of King Nole". It works on a US ROM of the game by randomizing item sources and altering the game so that it is more enjoyable in a randomizer format.

Usage

GUI is still in early stages and quality of life features will be added in the near future.

Setup

  • Download the lastest release of the GUI and extract its files anywhere you want.
  • Download the lastest release of Randstalker and extract its files anywhere you want.
  • Now you can launch the GUI. If you don't have a UserConfig file, a popup will ask for the various path needed for the GUI to work.

Features

Homepage

Used to generate a seed. You can choose the preset and personal settings you want. In the recap, you can specify a permalink (useful for races) and a customized name for the output rom. Once the seed is generated, you can copy the permalink by clicking on the related button.

Settings

Used to edit the preset and personal_settings json files.

In the Preset tab, beware of the Starting items, Items distribution and Hints sections as no securisation mechanism is implemented in the GUI.

Options

In the Options menu, you can change the language of the GUI and also configure the paths for various files.

Tips and tricks

  • Don't forget to use the save buttons after editing parameters (preset, personnal settings and user config)
  • If you want to edit the json files by hand, please restart RandstalkerGUI for it to read the new values
  • Don't forget to read the Setup section

randstalkergui's People

Contributors

hawkrex avatar

Watchers

 avatar

randstalkergui's Issues

Report Randstalker checks on preset in the GUI

The most obvious setting to check when editing presets is the "Items distribution" as if the total count of items is not correct, the Randstalker will not generate a seed.

Try to use validation rules for simple settings, may be difficult for settings like the one above.

Add Plandomizer functionality

Not a priority

Use the tools "hidden" in the preset file to make an interface for a plandomizer, maybe with the help of maps to place items and hints ...

Make initial config lighter / easier

Currently, the initial config asks you to fill those params :

image

Five entries seems a bit tedious to fill, especially when the common use case is very simple :

  1. User downloads Randstalker, extracts it to a folder
  2. User downloads GUI, extracts it to a folder
  3. User launches GUI

From there, the user only needs to specify 3 things for the app to work:

  • the location of the randstalker directory
  • the input rom location
  • the output roms folder (pre-filled with "./seeds/" so that seeds are generated inside a GUI subfolder)

Preset folder?

People won't fiddle manually with preset files (or very rarely), so they don't need to know where they are stored, as long as it works.
Since default presets needs to be included and we don't want to put that kind of responsability on the GUI, we'll just use a subfolder of randstalker called "presets".
Either we leave the option to change this, in which case we need some kind of auto-filled entry (which concatenates "/presets/" to the provided randstalker folder), OR we just remove this option completely and people will learn that their presets are in a well-named randstalker subfolder.

Personal settings folder?

Personal settings are just a way to store the most common personal settings in a convenient file so that people don't have to change those everytime. I think it needs to be handled as a file, rather than a folder of various personal settings. But more importantly, it must not matter how it is stored for the player, but it needs to be easily accessed from the front page to switch quickly on-the-go.

Add themes (Dark theme)

Adding a theme selector in the "Options" header, maybe just for switching between light and dark theme at first.

If you are motivated, you can add a new window to fully customize a theme (Check softwares like Notepad++ for inspiration), but this is purely bonus

Improve preset selector

Preset selector is currently shown as such :

image

This has, in my opinion, several issues :

  • The root folder node should not be displayed. Folder contents should be shown as root nodes
  • Only ".json" file nodes should be displayed (clicking any other kind of file crashes anyway)
  • Make it larger, as names are pretty much not readable fully currently

There are other, more subjective improvements that could be done:

  • Remove the ".json" extension to the tree nodes. We are not displaying files, we are displaying presets.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.