Skip to content

AngellusMortis/boundlexx

Repository files navigation

Boundlexx

Built with Cookiecutter Django

Black code style

License

MIT

Requirements

This project is configured to work with Docker inside of VS Code using the Remote Containers extension. It is recommend to use those. So make sure you have:

  • Docker Engine and Compose. Requires at least
  • Docker Buildkit enabled (add export DOCKER_BUILDKIT=1 to your shell rc or set it manually before running commands)
  • VS Code with the Remote Containers extension.
  • MacOSX version of Boundless installed somewhere. You can use steamcmd to install it via the following command:

    steamcmd +@sSteamCmdForcePlatformType macos +login username +force_install_dir /path/to/install +app_update 324510 -beta testing validate +quit
  • Boundless Icon Renderer set up and ran if you want to import item images into Boundlexx

Setup

  1. Clone the repo.
  2. Copy docker-compose.override.example.yml to docker-compose.override.yml and update the path you your local Boundless install
  3. Then open the boundlexx folder in VS Code.
  4. Ensure the extension "Remote - Containers" (ms-vscode-remote.remote-containers) is installed.
  5. You should be prompted to "Reopen in Container". If you are not, run the "Remote-Containers: Reopen in Container" from the Command Palette (View -> Command Palette... or Ctrl+Shift+P)
  6. VS Code will now build the Docker images and start them up. When it is done, you should see a normal VS Code Workspace
  7. Go to http://127.0.0.1:8000 in your Web browser and click "Sign In". Then sign in with Discord or Github
  8. Back in VS Code, run the command "Tasks: Run Task" and then "Boundlexx: Make Superuser".
  9. Enter the username for your user when prompted.
  10. Repeat "Tasks: Run Task" for the "Boundlexx: Ingest Game Data" and "Boundlexx: Create Game Objects" tasks.

Releases

No releases published

Packages

No packages published