For Developers - Bram-Hub/LEGUP GitHub Wiki

Description of the Dev Tabs

• Programming Standards - Explaining the work flow, commenting guide, steps to make an issue, and how to submit a pull request.

• Naming Convention - Describes the naming conventions for folders and functions. As well as describing key words that are shared across projects.

  • Folder Structure - Description the structure of the folder system as well as puzzle rules and puzzle files.

• Developer Setup Guide - Shows how to set up one's environment for working on LEGUP in Windows and Mac.

• Alternative Developer Setup Guide (linux) - Shows how to set up one's environment for working on LEGUP in Linux.

• Pointers for Getting Started - List of what is completed and what is good place to start working on LEGUP for people who are new to the project.

• Guide to Implementing Puzzles - This page aims to be a straightforward guide for developers in creating a new puzzle for LEGUP.

  • Organization and Classes - Walks one through the process of Organization and setting up how the classes are meant to be formatted.
  • Adding Rules - Walks one through how to add rules for the Contradiction Rule, Case Rule, and Direct Rule.
  • GUI - Walks one through how to implement the visual aspect to the puzzle.
  • Puzzle Files, Importing, and Exporting - Shows how to set up exporting, importing, and how to set up the XML file.

• Guide to Implementing the Puzzle Editor Functionality for a Puzzle - (WIP) Shows how to set up a puzzle to be able to be used in the file editor.

  • Enabling puzzle file creation - Shows what changes needed to be made to what configs to get the file creation working.

  • Specifying valid board dimensions - Setting up board restrictions and dimensions.

  • Creating tiles - Shows how to create tiles for the puzzle.

  • Initializing an empty puzzle. Each puzzle will only use one of the two methods:

    • From row and column input - Shows how to interpret puzzles from a row - column based input.
    • From text input (WIP) - Shows how to interpret puzzles from a text based input. Need to add more code to show an example.

  • Implementing cell modification functionality - shows how to allow for cell modification

  • Implementing the ability to save files - shows how to implement saving of files using the PuzzleExporter

• Template for the Wiki - A template for how to set up a wiki page for a puzzle.

• Native Binary Compilation Information for Windows - Shows how to compile the files on Windows using Launch4j.

• Test Suite Documentation - Where all the puzzle documentation for the test cases are.

  • Nurikabe Test Suite Docs
  • Tree Tent Test Suite Docs
  • Star Battle Test Suite Docs
  • Light Up Test Suite Docs

• UML Diagrams - A description of how to create UMLs

  • UML UI - Collection of all the UML Diagrams for the UI
  • UML Puzzles - Collection of all the UML Diagram for the each of the Puzzles.