MCPcopy Index your code
hub / github.com/Kumassy/ownserver-client-gui

github.com/Kumassy/ownserver-client-gui @app-v0.11.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release app-v0.11.0 ↗ · + Follow
79 symbols 209 edges 50 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

OwnServer Client GUI

screenshot

Overview

This software aims to minimize cost and effort to prepare local game server like Minecraft, Factorio, RUST and so on.

  • Cost you'll save
  • You can utilize any redundunt compute resource for game server as long as they can connect to the Internet.
  • You can save cost for Cloud, VPS.
  • Effort you'll save
  • No firewall, NAT settings is required.

This repository provides GUI application, which is the frontend of ownserver

Prerequisite

Game Requirement
Minecraft java installed
Factorio docker installed

Installation

Pick the latest release from here: https://github.com/Kumassy/ownserver-client-gui/releases

for Windows user, download *.msi.
for macOS user, download *.dmg.
for Linux user, download *.AppImage.

Contributing

This software uses tauri framework. Read about tauri here.

Build

yarn install
yarn tauri dev # run app in debug mode
yarn tauri build # build app for release

Issue, PR

Feel free to open Issues and Pull Requests!

License

MIT

Extension points exported contracts — how you extend this code

Endpoint (Interface)
(no doc)
src/common.ts
CheckRegistry (Interface)
(no doc)
src/checks.ts
GameState (Interface)
(no doc)
src/features/gameSlice.ts
GameTaskSectionProps (Interface)
(no doc)
src/forms/components/GameTaskSection.tsx
ClientInfo (Interface)
(no doc)
src/common.ts
TunnelState (Interface)
(no doc)
src/features/tunnelSlice.ts
FormFooterProps (Interface)
(no doc)
src/forms/components/FormFooter.tsx
InitializedTauriState (Interface)
(no doc)
src/features/tauriSlice.ts

Core symbols most depended-on inside this repo

log
called by 21
src-tauri/src/logger.rs
useAppDispatch
called by 10
src/app/hooks.ts
getCheckList
called by 3
src/checks.ts
formatProtocol
called by 2
src/common.ts
getGameName
called by 2
src/Inquiry.tsx
constructLogLines
called by 2
src/Inquiry.tsx
getStateFilePath
called by 2
src/app/persist.ts
loadState
called by 2
src/app/persist.ts

Shape

Function 53
Interface 15
Class 4
Method 4
Enum 3

Languages

TypeScript84%
Rust16%

Modules by API surface

src/Inquiry.tsx7 symbols
src-tauri/src/logger.rs7 symbols
src/common.ts6 symbols
src/App.tsx5 symbols
src/steps/StepMonitoring.tsx4 symbols
src/checks.ts4 symbols
src/features/localSlice.ts3 symbols
src/app/persist.ts3 symbols
src-tauri/src/main.rs3 symbols
src/utils.tsx2 symbols
src/steps/StepLaunchTunnel.tsx2 symbols
src/forms/components/GameTaskSection.tsx2 symbols

For agents

$ claude mcp add ownserver-client-gui \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page