-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
38 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,28 @@ | ||
!!! info "Describes how to compile and run the Nexus Mods App." | ||
## Code Contributions | ||
|
||
The Nexus Mods App is programmed in C# with latest .NET Runtime. Setup should be easy. | ||
### Prerequisites | ||
|
||
- The latest version of the [.NET SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). | ||
- An IDE: | ||
- [JetBrains Rider](https://www.jetbrains.com/rider/) and the [Avalonia Rider Extension](https://plugins.jetbrains.com/plugin/14839-avaloniarider), | ||
- [Visual Studio](https://visualstudio.microsoft.com/downloads/) and the [Avalonia Visual Studio Extension](https://marketplace.visualstudio.com/items?itemName=AvaloniaTeam.AvaloniaVS). | ||
|
||
## Prerequisites | ||
|
||
- Download the Latest [.NET SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). | ||
- Download an IDE, recommended options below: | ||
- [Visual Studio](https://visualstudio.microsoft.com/downloads/) | ||
- [JetBrains Rider](https://www.jetbrains.com/rider/) | ||
|
||
Our development team uses Rider; however, Visual Studio is a great free offering on Windows. | ||
Other code editors, like [VS Code](https://code.visualstudio.com/), may work for you with [extensions](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit); | ||
however, they may be a bit more complicated to use. | ||
|
||
That's all. Open the project (`.sln`), build, and you're done. | ||
There are also some [Item Templates](https://github.com/AvaloniaUI/avalonia-dotnet-templates) for Avalonia that can be very useful to have, | ||
helping you make things like new 'Windows' and 'Controls' easier. | ||
|
||
## Tools for UI Development | ||
### Writing code | ||
|
||
Visual Studio and JetBrains Rider both have avalonia extensions that allow previewing ui designs (`.axaml` files). | ||
Make sure to follow our [Development Guidelines](./development-guidelines/UICodingGuidelines.md). | ||
|
||
- [Visual Studio Extension](https://marketplace.visualstudio.com/items?itemName=AvaloniaTeam.AvaloniaVS) | ||
- [Rider Extension](https://plugins.jetbrains.com/plugin/14839-avaloniarider) | ||
## Translations | ||
|
||
You can install via the web or from inside the IDE extension managers themselves. | ||
Translations are currently handled via the IDE. See [this issue](https://github.com/Nexus-Mods/NexusMods.App/issues/598) for more details. | ||
|
||
There are also some [Item Templates](https://github.com/AvaloniaUI/avalonia-dotnet-templates) for Avalonia that can be very useful to have, | ||
helping you make things like new 'Windows' and 'Controls' easier. | ||
## For Package Maintainers | ||
|
||
## Code Guidelines | ||
If you want to create a package for your distribution, here are some helpful tips to get started: | ||
|
||
Have a look inside [Development Guidelines](./development-guidelines/DependencyInjection.md) 😉. | ||
- If possible, use `nexusmods-app` for the package name. | ||
- We ship a build of `7zz` and use that executable unless you set `NEXUSMODS_APP_USE_SYSTEM_EXTRACTOR=1` when publishing. See [this issue](https://github.com/Nexus-Mods/NexusMods.App/issues/1306#issuecomment-2095755699) for details. | ||
- Set `INSTALLATION_METHOD_PACKAGE_MANAGER` when publishing. We have an integrated updater that will notify users about new versions. If you set this flag, we'll tell the user to update with their package manager. | ||
- Let us know if you have questions or if you published a new package by joining our Discord. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters