Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AM2R-Community-Developers/AM2RLauncher

Host respository for the AM2RLauncher.
https://github.com/AM2R-Community-Developers/AM2RLauncher

Last synced: about 1 month ago
JSON representation

Host respository for the AM2RLauncher.

Host: GitHub
URL: https://github.com/AM2R-Community-Developers/AM2RLauncher
Owner: AM2R-Community-Developers
License: gpl-3.0
Created: 2021-03-18T04:30:34.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-08-15T17:01:51.000Z (4 months ago)
Last Synced: 2024-08-15T19:12:25.166Z (4 months ago)
Language: C#
Homepage:
Size: 1.8 MB
Stars: 356
Watchers: 18
Forks: 19
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - AM2R-Community-Developers/AM2RLauncher - Host respository for the AM2RLauncher. (C# #)

README

# AM2RLauncher
A front-end application that simplifies installing the latest AM2R-Community-Updates, creating APKs for Android use, as well as Mods for AM2R. It supports Windows (x86/x64) as well as Linux (x64).

## What is this?
AM2R (Another Metroid 2 Remake) is a fan-made remake of *Metroid II: Return of Samus* in the style of *Metroid: Zero Mission*. It was released in 2016 by DoctorM64 and his team, and very soon after, has received a DMCA letter from Nintendo.
A few years after, multiple members of the community managed to reverse engineer the game and published unofficial updates, dubbed the AM2R-Community-Updates. Those fixed bugs and added new features like widescreen, added content planned by the original devs before they were struck down, and ported it to other platforms.

The AM2RLauncher lets you conveniently play those Community-Updates, automatically receive updates, install AM2R mods and create APKs to play on your phone.
No copyrighted files are shipped, you need to provide your own copy of AM2R_11!

For further questions regarding AM2R [see this FAQ](https://am2r-community-developers.github.io/DistributionCenter/faq.html).
For further questions regarding the AM2RLauncher [see this Wiki](https://github.com/AM2R-Community-Developers/AM2RLauncher/wiki).
For further communication, you can reach us on [Discord](https://discord.gg/nk7UYPbd5u), [Matrix](https://matrix.to/#/#am2r-space:matrix.org), or [GitHub issues](https://github.com/AM2R-Community-Developers/AM2RLauncher/issues).

## Downloads
![GitHub release (latest by date)](https://img.shields.io/github/v/release/AM2R-Community-Developers/AM2RLauncher?label=GitHub&logo=github&style=flat-square) ![Flathub](https://img.shields.io/flathub/v/io.github.am2r_community_developers.AM2RLauncher?label=FlatHub&logo=flathub&logoColor=white&style=flat-square)
![AUR version](https://img.shields.io/aur/version/am2rlauncher?label=AUR&style=flat-square)
Downloads can be found at the [Release Page](https://github.com/AM2R-Community-Developers/AM2RLauncher/releases).

For all Linux users, a [Flatpak](https://flathub.org/apps/details/io.github.am2r_community_developers.AM2RLauncher) is available and can be installed with all above dependencies bundled. This method is the recommended way for Steam Deck users.

### Arch Linux

For Arch Linux users an [AUR Package](https://aur.archlinux.org/packages/am2rlauncher/) also exists. Install it with `makepkg -si` or use your favourite AUR helper.

### NixOS

The launcher has also been packaged for NixOS. It can be run with `nix run nixpkgs#am2rlauncher`.

## Dependencies
Windows needs the [.NET Framework 4.8 runtime](https://dotnet.microsoft.com/download/dotnet-framework/net48) installed.
Linux needs the following dependencies installed:

- [.NET Core 6.0 runtime](https://dotnet.microsoft.com/download/dotnet/6.0) or later. .NET Core 6.0 is preferred.
- `xdelta3`
- `gtk3`
- `libappindicator3`
- `webkitgtk`
- `openssl`
- `fuse2`

As well as these dependencies to run AM2R:
- 32-bit version of `libpulse`
- 32-bit version of `openal`
- 32-bit version of your graphics drivers

Optionally, for APK creation any Java runtime is needed.

For more detailed instructions check out the [installation process wiki page](https://github.com/AM2R-Community-Developers/AM2RLauncher/wiki/Installation-Process).

## Configuration and Data Files
The AM2RLauncher stores its files in the following places:
- On Windows, it stores the config file to the `AM2RLauncher.exe.config` next to the binary, and its data files in the same folder as the binary.
- On Linux, it stores the config file to `$XDG_CONFIG_HOME/AM2RLauncher` and its data files to `$XDG_DATA_HOME/AM2RLauncher` (which are defaulting back to `~/.config` and `~/.local/share` respectively).

The AM2RLauncher data can get quite big, so if you wish to change where it stores it, you can do so with the `AM2RLAUNCHERDATA` environment variable (i.e `$env:AM2RLAUNCHERDATA="D:\MyLauncherData"` or `AM2RLAUNCHERDATA="/mnt/bigDrive/launcherData"`).
**Data files are different for each OS, you cannot mix and match them!**

If you wish to redistribute the AM2RLauncher to some Linux distro, you can use the `NoAutoUpdate` configuration, in order to build the AM2RLauncher with the auto-updating features disabled. Further assets (.desktop file, icon, appdata) can also be found in this directory: `./AM2RLauncher/distribution/linux`.

# Contributing
Contributions of any kind are always welcome! Here's possible methods on how you can contribute:
- Keep the [Wiki](https://github.com/AM2R-Community-Developers/AM2RLauncher/wiki) up-to date should any changes occur. Or notify us if it isn't.
- Help us with translating the AM2RLauncher into more languages. You can find the language files [here](https://github.com/AM2R-Community-Developers/AM2RLauncher/tree/main/AM2RLauncher/AM2RLauncher/Language).
- Test the development builds for any regressions, check any of the [`TODO`s](https://github.com/AM2R-Community-Developers/AM2RLauncher/search?q=todo) that need testing or help with experimental features (like macOS).
- Submit Pull Requests to fix bugs or implement new features.

# Compiling Instructions:
## Dependencies
For compiling for Windows .Net Framework 4.8 SDK is needed. For Linux and Mac .Net Core 5.0 SDK or later is needed.

## Windows Instructions
Open the solution with Visual Studio 2019.
Alternatively, build via `dotnet build` / the `buildAll` batch file.

## Linux Instructions
In order to build for linux, use `dotnet publish AM2RLauncher.Gtk -p:PublishSingleFile=true -p:DebugType=embedded -c release -r ubuntu.18.04-x64 --no-self-contained`, MonoDevelop sadly doesn't work.
You *have* to specify it to build for Ubuntu, even on non-Ubuntu distros, because one of our Dependencies, libgit2sharp fails on the `linux-x64` RID.

### Arch Linux
An `am2rlauncher-git` [AUR Package](https://aur.archlinux.org/packages/am2rlauncher-git/) also exists.

### NixOS
On NixOS, the `am2rlauncher` package can be used for installation.

## Mac Instructions
You can open the solution with Visual Studio for Mac, but it likely will crash after compliation. Use `dotnet publish AM2RLauncher.Mac -c release` instead.
Note that Mac is currently **unsupported**. We will try to answer questions, but cannot guarantee to fix issues with Mac.