Skip to content

dobsondev/N64RecompLauncher

 
 

Repository files navigation

N64Recomp Launcher

.NET 9 License

N64Recomp Launcher Screenshot A modern, user-friendly launcher application for managing and running N64 recompiled games. This tool streamlines the process of downloading, installing, and launching your favorite N64 titles.

Features

  • Automated Updates: Seamlessly download and install the latest releases from GitHub
  • Version Management: Stay up-to-date with automatic version checking and updates
  • Game Management: Easy-to-use interface for launching your N64 games
  • Smart Integration: Direct integration with GitHub releases for smooth updates

Getting Started

Prerequisites

  • .NET 9 Runtime (get it here)
  • Internet connection for updates and downloads

Installation

  1. Download the latest release from the Releases page
  2. Extract the downloaded archive to your preferred location
  3. Run the executable.

Usage

  1. Launch the application
  2. The launcher will automatically check for updates on startup
  3. Browse your game library through the intuitive interface
  4. Select a game and click "Download/Launch" to play

Configuration

GitHub API Token

To avoid hitting GitHub's API rate limits, you can provide a personal access token. Create a token with no special permissions needed and set it in the launcher settings. You can create a token at GitHub Settings -> Developer settings > Personal access tokens > Tokens (classic) > Generate new token You don't need to give it any special permissions. Then paste that Token into your Settings field. Do not share your Token!

games.json Structure

The launcher uses a games.json file to manage the available games. You can customize this file to add your own games or modify existing entries. The file is organized into three categories: standard, experimental, and custom.

Game Entry Properties

Each game entry requires the following properties:

  • name - The display name of the game as it appears in the launcher
  • repository - The GitHub repository in the format username/repository
  • folderName - The folder name where the game will be downloaded and installed
  • gameIconUrl URL of the game's icon image. If null, a default icon will be used.

Example Configuration

{
    "standard": [
        {
            "name": "Example Game",
            "repository": "username/example-game-repo",
            "folderName": "ExampleGame",
            "gameIconUrl": null
        },
        {
            "name": "Another Game",
            "repository": "anotheruser/another-game-repo",
            "folderName": "AnotherGame",
            "gameIconUrl": "link/to/an/image.png"
        }
    ],
    "experimental": [
        {
            "name": "Experimental Game",
            "repository": "expuser/experimental-game-repo",
            "folderName": "ExperimentalGame",
            "gameIconUrl": "link/to/a/different/image.jpg"
        }
    ],
    "custom": []
}

Support

If you encounter any issues or have questions:


Made with ❤️ for the N64 community

About

A Launcher that Downloads and Updates N64 Recompilations

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • C# 100.0%