User Guides

Installation & Setup

  1. Download the Homegames server bundle for your operating system from homegames.io
  2. Note: if you're using Windows, you will likely see a warning message that looks like this. The ability to sign these builds costs money, so we don't do it. To continue installation, click "More info" and then "Run anyway"
  3. Once homegames is installed, all you have to do is run the app and wait for the initial setup to complete. This process involves creating a certificate and DNS record to map to your local Homegames instance. It should take around 2 to 3 minutes to complete the first time. If it takes more than 5 minutes or if it breaks, please let us know using the contact form at the bottom of the page.
  4. Once your cert and DNS record have been generated, your homegames instance is up and running on your local network.

Playing Games

  • Once your server is up and running, you can access the Homegames dashboard from any device on the same network as your server. All you have to do is navigate to homegames.link in a web browser, and you will be redirected to your local instance (it will look like [nonsense].homegames.link).
  • Navigate the dashboard using the arrows on the right side to find a game you want to play. You can also search by clicking the red "search" box. Once you find one, click it to join any ongoing game sessions for that game, or create your own.
  • Once you're in a game session, you'll see a "spectate" button on the top left, which will let you drop out as a player and drop in as a spectator, or vice versa.
    The blue section at the top shows your current player name. You can click it and change your name, as well as see information about the current game session.
    The red text on the top right shows the code you can give someone not on your same network to play with you at public.homegames.link

    • Configuring Your Server

    This section is still a work-in-progress
    I plan on implementing a UI for these values at some point in the future, especially since the current implementation is a mess.
    Here is the default config in JSON format 
    {
    "HTTPS_ENABLED": true,
    "LINK_ENABLED": true,
    "HOMENAMES_PORT": 7400,
    "HOME_PORT": 9801,
    "LOG_LEVEL": "INFO",
    "GAME_SERVER_PORT_RANGE_MIN": 8300,
    "GAME_SERVER_PORT_RANGE_MAX": 8400,
    "IS_DEMO": false,
    "BEZEL_SIZE_X": 9,
    "BEZEL_SIZE_Y": 9,
    "HOTLOAD_ENABLED": false,
    "PERFORMANCE_PROFILING": false,
    "DOWNLOADED_GAME_DIRECTORY": "hg-games",
    "LOG_PATH": "homegames_log.txt",
    "PUBLIC_GAMES": true,
    "ERROR_REPORTING": true,
    "ERROR_REPORTING_ENDPOINT": "https://api.homegames.io/bugs",
    "CERT_DOMAIN": "homegames.link",
    "TESTS_ENABLED": true,
    "API_URL": "https://api.homegames.io",
    "LINK_PROXY_URL": "wss://public.homegames.link:81",
    "LINK_URL": "wss://homegames.link",
    "MAP_ENABLED": true
}
    You can copy and paste this as `config.json` and modify it as you see fit in either:
    • Windows: /Path/To/Your/User/AppData/Roaming/homegames/config.json
    • MacOS: /Users/you/Library/Application Support/homegames/config.json
    • Linux: /path/to/home/directory/.homegames/config.json

    Downloading Games

    In addition to playing built-in games, you can download games published by members of the Homegames community. To find something you want to play, you can either browse the catalog or search using the Homegames dashboard.

    Every game available via search has at least one version published to the catalog. Versions published to the catalog are reviewed and approved by Joseph personally. You can switch versions (if available) by clicking the left and right arrows in the top right of the game popup.

    Game versions that have not been published in the catalog (but have passed automated testing and validation) are still playable, but you will see a warning in the UI letting you know the game has not been reviewed.