https://github.com/mp3martin/gameinv
A project showcasing how you can connect C# backend and Next.js or WPF frontend
https://github.com/mp3martin/gameinv
csharp dotnet dotnet9 gui prebuilt-binaries python tui websocket wpf
Last synced: about 2 months ago
JSON representation
A project showcasing how you can connect C# backend and Next.js or WPF frontend
- Host: GitHub
- URL: https://github.com/mp3martin/gameinv
- Owner: MP3Martin
- License: mit
- Created: 2024-10-28T17:06:11.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-05T16:39:48.000Z (4 months ago)
- Last Synced: 2025-06-05T17:36:41.102Z (4 months ago)
- Topics: csharp, dotnet, dotnet9, gui, prebuilt-binaries, python, tui, websocket, wpf
- Language: C#
- Homepage: https://mp3martin.github.io/GameInv/
- Size: 1.42 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](#/)
[
](#/)
[
](#/)
[
](#/)
[
](#/)
# GameInv
## Usage
### Console / WEB UI
1. Get the GameInv server
1. by downloading the [latest build from releases](https://github.com/MP3Martin/GameInv/releases/latest/) (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](https://github.com/MP3Martin/GameInv/releases/latest/) (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)
## 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`](server/.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](server/gameinv.sql) to add the schema and the
tables (find a tutorial elsewhere). Then [configure](#configuration) your program to use the MySQL DB.
## GUI
There is also a WPF GUI version of the project in [server/GameInv-WPF](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](https://github.com/MP3Martin/GameInv/releases/latest/).
## More docs
Can be found [here](DOCS.md)