Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/seraxis/lr2oraja-endlessdream/llms.txt

Use this file to discover all available pages before exploring further.

Endless Dream is a community-driven project and welcomes contributions of all kinds — bug fixes, new features, skin improvements, and documentation. The project is hosted on GitHub and most collaboration happens through issues, pull requests, and the Discord server.

​
Contribution workflow

1

Discuss your idea first

Before writing any code, take a moment to discuss what you want to build. This helps avoid duplicate effort and makes sure your contribution aligns with the project’s direction.
  • Open a GitHub issue to describe the bug or feature.
  • Or join the Discord server to talk it through with other contributors and maintainers.

Join the Discord server

The Discord server is where most day-to-day communication and collaboration happens. Ask questions, share ideas, and get feedback before you start.
2

Fork the repository and create a branch

Fork the repository on GitHub, then clone your fork with submodules:
git clone --recurse-submodules git@github.com:YOUR_USERNAME/lr2oraja-endlessdream.git
Create a new branch for your work. Use a descriptive name that reflects what you are changing:
git checkout -b my-feature-name
3

Verify submodule setup

The project uses two Git submodules located in core/dependencies/:
  • jbms-parser — BMS/BMSON chart parser
  • jbmstable-parser — difficulty table parser
Confirm both directories are populated after cloning:
ls core/dependencies/
If either folder is empty or missing, initialize them with:
git submodule update --init --recursive
In IntelliJ IDEA, missing submodules can cause “Cannot Resolve Symbols” errors for classes like bms.model.*. This does not prevent the project from building or running. See the running guide for instructions on how to fix symbol resolution in the IDE.
4

Make your changes

Implement your fix or feature. Use IntelliJ IDEA Community Edition or another Java IDE for the best development experience. Refer to the build guide and running guide for how to compile and test your changes locally.
5

Open a pull request against main

Push your branch to your fork and open a pull request against the main branch of the upstream repository. A maintainer will review your code and provide feedback.Make sure to:
  • Write a clear description of what the PR changes and why.
  • Reference any related issues using Closes #123 or Fixes #123.
  • Keep the PR focused — one concern per pull request is easier to review and merge.

Build docs developers (and LLMs) love

Get started for freeTalk to us