GameInv

Usage

Console / WEB UI

1. Get the GameInv server
   1. by downloading the latest build from releases (the one with .exe and no WPF in its name)
   2. or ...

      or download the server folder, extract it and open it in your favourite IDE, install the required dependencies, modify the code however you want and run the program. Or just use any other way to build the project.
2. Run the program (the server)
3. Press Y to enter the WS server mode.
4. Open https://mp3martin.github.io/GameInv/ in your browser and everything should connect automatically. Use the cogwheel on the top right to change settings.

Warning

Do not run the server publicly, it is just a demo/showcase and not advanced enough to be perfectly secure and handle attacks.

Windows desktop GUI (WPF)

1. Get GameInv WPF by downloading the latest build from releases (the one with .exe and WPF in its name)
2. Run the program

Important

Microsoft Defender sometimes reports the automatically built exes as a virus. The current fix is to allow the .exe in Defender.

Tip

Read configuration

Configuration

.env

This program allows you to configure various options through the .env file or by setting environment variables. The .env file has to be placed in the same directory as the program executable. The .env.example file provides a description for these settings, so read it. To use it, rename .env.example to .env and modify the values as needed. Note that environment variables set in the system or command line must be prefixed with GAMEINV_, but the .env file does not require this prefix.

MySQL

If you want the items to be stored in a database (specifically MySQL), then you have to connect to / start a MySQL server and run the commands inside gameinv.sql to add the schema and the tables (find a tutorial elsewhere). Then configure your program to use the MySQL DB.

GUI

There is also a WPF GUI version of the project in server/GameInv-WPF. It only supports Windows 7+ and no other OS. Tested on Windows 11. That version does not have a WebSocket client, does not have TUI and only has an integrated WPF GUI with optional DB connection. If you want to download a prebuilt .exe, then find the one that has WPF in its name in the latest release.

More docs

Can be found here