Skip to content

ComradeNapCali/BrickHillCrossoverLauncher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Brick Hill CrossOver Launcher

A (browser-less) Brick Hill launcher designed for CrossOver.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Building
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a launcher for Brick Hill designed for CrossOver or other Wine bottles.

Using this, the game is fully playable on Mac and Linux under Wine without needing a web browser.

The launcher is written in Rust and gtk-rs. This is actually the first project I have written in Rust, so the code might not be the neatest.

(back to top)

Getting Started

Installation

Before you continue, make sure CrossOver is installed on your Mac or Linux device.

  1. Go to the Brick Hill website and either log into or register your account.
  2. Go to the download page highlighted in the below photo.

  1. On the download page, download the legacy client.

  1. Open CrossOver, then go to Bottle -> New Bottle and name it something along the lines of "Brick Hill".
  2. Install the legacy client onto the newly created bottle.
    • If you are on an Apple Silicon device and the installer quits immediately, you can open cmd on the bottle, put the path to the installer, and press enter.
  3. Go to the releases page and download the latest version's zip file.
  4. Extract the launcher to the virtual C drive of your bottle.
  5. Click Run Command and browse to "BrickHillCrossoverLauncher.exe", then click on "Save Command as a Launcher".
  6. Double click the launcher from the bottle's app list.
  7. When the launcher opens, click the "Launch Game" button to create the config file.
  8. Using a cookie editor (such as EditThisCookie), get and copy your entire Brick Hill session cookie.
    • Do NOT share this cookie with anyone, as it can be used to access your account.
  9. Open the "config.json" file in the launcher's folder in your favorite text editor.
  10. Replace "INSERT_YOURS_HERE" with your copied cookie.
  11. Close the launcher.

Joining a game (Brick-Hill)

  1. Find a game you want to play on the Brick Hill website and copy the URL.
  2. Double click the launcher from the bottle's app list.
  3. Paste (or manually enter) the link into the launcher and click "Launch Game".
  4. If successful, Brick Hill will open up. Have fun!

Joining a game (Node-Hill)

  1. Launch a Node-Hill server.
  2. Double click the launcher from the bottle's app list.
  3. Enter localhost into the launcher and click "Launch Game".
  4. If successful, Brick Hill will open up into your local server. Happy developing!

(back to top)

Building

You will need the following in order to build the launcher:

  1. Clone this repository to an easy to remember folder.
  2. Open a MSYS2 MingW-w64 shell and cd into the project folder.
  3. Run cargo b --release to build the executable.
  4. If you can't run the built program out of the gate, move the executable into a new folder and copy all of the .dll files found in msys2/mingw64/bin.

(back to top)

Roadmap

  • Cleaning up the code.
  • Figure out a better way to get the session cookie.
  • Add localhost support (for node-hill development)
  • Add a favorite games list feature.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would improve this project, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star if you find this useful! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the BSD-3 License. See LICENSE.txt for more information.

(back to top)

Contact

My Brick Hill username is ComradeNC; if you see me on a game, feel free to say hi!

If you want to add me on Discord, my username is @unity3d. Friending you back is not guaranteed however.

Project Link: https://github.com/ComradeNapCali/BrickHillCrossoverLauncher

(back to top)

Acknowledgments

  • Mooshimity, for making Brick Hill itself.
  • Rust, for being a beloved programming language.
  • CodeWeavers, for making CrossOver, and supporting Wine development.

(back to top)