Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.48 KB

README.md

File metadata and controls

52 lines (40 loc) · 2.48 KB

lam-karaoke

musings and prototypes in Godot for new karaoke engine

Installation

Development is currently done using a custom build available at https://github.com/ProjectLam/godot/tree/lam-godot.

  1. Clone/download this repository to your machine.
  2. Download the latest release from https://github.com/ProjectLam/godot-build-scripts/releases.
  3. Extract the downloaded file to a location of your choice. Godot is self-contained and does not require installation. The downloaded file will contain templates and tool folders. the engine executable will be in the tool folder.
  4. Run the Godot 4 executable and press the Import button, select the folder containing this repository on your machine.
  5. Once the project opens, navigate to the Project menu, and select Export.
  6. In the Export window, select Windows Desktop (Runnable) from the list of available platforms.
  7. Specify an Export Path where the game executable should be written.
  8. Press the Export Project... button.
  9. [Optional] Tick/untick Export With Debug.
  10. Press Save.
  11. You should now have lam.exe in the folder you've selected previously.

Testing Multiplayer (on Windows)

Assuming you've already generated the game executable create a couple of shortcuts to launch multiple instances of the game. The email/password can be almost anything, the account will get automatically created if it doesn't exist.

  1. Create a shortcut named Player 1 for the game executable, set the Target to 
    <path\to\lam.exe> -- --email="[email protected]" --password="player1pass"
  2. Create another shortcut named Player 2 for the game executable, set the Target to 
    <path\to\lam.exe> -- --email="[email protected]" --password="player2pass"
  3. Copy some songs to %APPDATA%\Lam Godot\app_userdata\Lam-dj\songs.
  4. Launch Player 1 game and Player 2 game.
  5. As Player 1 select an instrument in the game window and press the Get that button.
  6. Press Matches button.
  7. Press Create New Match button.
  8. Double-click on a song on the right-hand side.
  9. As Player 2 select the same instrument, press Matches button, then double-click to join the match created by Player 1.

Testing Multiplayer (on Linux)

Similar to windows, but the songs directory should be at $HOME/.local/share/lam_godot/app_userdata/Lam-dj/songs

License Agreement

TODO We are working on this

CLA Agreement

Any pull requests to these repo require a CLA https://cla-assistant.io/ProjectLam/learn_music_game