TWLauncher (Teeworlds Launcher, or TWL) is a Windows application designed to simplify the management and launching of various Teeworlds clients. With a cool, modern interface, it supports popular clients & automatic updates.
- Launcher Interface
- Game Management: Easily launch popular Teeworlds clients from a single interface.
- Steam Integration: Automatically detects and launches Steam-installed clients like Teeworlds and DDraceNetwork.
- Client Installation: Downloads and installs clients (e.g., TClient, Cactus) with the latest versions.
- System Tray: Minimize to the system tray with a quick-access menu for launching clients.
- Modern UI: Customizable themes with a clean, modern design.
- Auto Updates: Checks and updates non-Steam clients to their latest versions.
- Discord RPC: Displays your current client and theme on Discord.
- Content Browser: Browse and download skins, game skins, emoticons, particles, and entities from teedata.net.
- Cross-Platform Potential: Built with Electron, enabling future multi-platform support (currently Windows-focused).
electron: Framework for building cross-platform desktop applications.electron-builder: Tool for packaging and distributing Electron apps.winreg: Accesses the Windows registry to locate Steam installations.axios: Handles HTTP requests for downloading updates and content.adm-zip: Manages ZIP file extraction for client installations.discord-rpc: Integrates Discord Rich Presence for status updates.dotenv: Loads environment variables (e.g., Discord Client ID).font-awesome: Provides icons for the user interface.fs-extra: Enhanced file system operations for configuration management.
- Download the latest release from GitHub Releases.
- Run the installer or extract the portable version.
- Launch
TWLauncher-x64.exeto start the application.
- Open TWLauncher.
- Select a client from the sidebar (e.g., Teeworlds, DDraceNetwork, TClient, Cactus).
- Click INSTALL to download a new client or LAUNCH to start an installed one.
- Use the Content Browser (plus icon) to download skins, emoticons, and more.
- Minimize to the system tray for quick access.
- Clone the repository:
git clone https://github.com/noxygalaxy/twlauncher.git
- Navigate to the project directory:
cd twlauncher - Install dependencies:
npm install
- Rename
.env.exampleto.envfile and replace inside with your own discord client id:DISCORD_CLIENT_ID=YOUR_DISCORD_CLIENT_ID
- Build the application:
npm run build
- Find the compiled app in the
distfolder.
Note: Discord RPC is optional.
- Teeworlds (
tw): Steam-based, launches viasteam://rungameid/380840. - DDraceNetwork (
ddnet): Steam-based, launches viasteam://rungameid/412220. - Tater Client (
tclient): Downloaded from sjrc6/TaterClient-ddnet. - Cactus Client (
cactus): Downloaded from other source.
TWLauncher stores its configuration in twlconfig.json located at C:\Users\<YourUser>\AppData\Roaming\TWLauncher. You can modify:
- installPath: Directory where non-Steam clients are installed (default:
AppData\TWLauncher\clients). - theme: UI theme (e.g.,
default, customizable via settings). - streamerMode: For now just hides installation path in settings. (default:
false)
We welcome contributions! To contribute:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -m "Add your feature"). - Push to the branch (
git push origin feature/your-feature). - Open a pull request.
Please report bugs or suggest features at GitHub Issues.
- Creator: @noxygalaxy
- Contributors: @dropalways.
- Made with: Love and Node.js <3
- Special Thanks: To the Teeworlds community for inspiration :)
- More Special Thanks:
- @sollybunny & @sjrc6 for allowing me use their Tater Client in launcher.
- @handerfall for allowing me use their Cactus Client in launcher.
TWLauncher is open-source and licensed under the MIT License.
- Discord: Join our server
- Telegram: Follow us
- Website: twlauncher.netlify.app
- Issues: Report bugs