Confirmedusers
278
edits
Modding:Setting up your Development Environment: Difference between revisions
From Vintage Story Wiki
Modding:Setting up your Development Environment (view source)
Revision as of 15:04, 26 February 2022
, 2 years agoUndo revision 36636 by F (talk)
(Marked this version for translation) |
Tag: Undo |
||
| Line 12: | Line 12: | ||
* [https://www.visualstudio.com/en/vs/community/ Visual Studio Community] is a free and very powerful development environment and covered in below guide. This is also the tool the Vintage Story Team uses to build the game. It also has a [https://www.visualstudio.com/vs/mac/ MacOS Version]. | * [https://www.visualstudio.com/en/vs/community/ Visual Studio Community] is a free and very powerful development environment and covered in below guide. This is also the tool the Vintage Story Team uses to build the game. It also has a [https://www.visualstudio.com/vs/mac/ MacOS Version]. | ||
* [https://www.jetbrains.com/rider/ Jetbrains Rider] is a freemium and modern development environment with seamless support for Visual Studio projects, keybindings and layouts. It is an enterprise product and some features are locked behind a license (code duplication checking, web dev tools), but the features that you need for VS mod development are all free. The indexing / go to reference features and built-in decompiling features are very powerful, as you are able to click on a method Vintage Story uses and it'll show you the code behind it. Do note that it currently has one bug + workaround documented [https://github.com/anegostudios/vsmodexamples/issues/11 here]. | * [https://www.jetbrains.com/rider/ Jetbrains Rider] is a freemium and modern development environment with seamless support for Visual Studio projects, keybindings and layouts. It is an enterprise product and some features are locked behind a license (code duplication checking, web dev tools), but the features that you need for VS mod development are all free. The indexing / go to reference features and built-in decompiling features are very powerful, as you are able to click on a method Vintage Story uses and it'll show you the code behind it. Do note that it currently has one bug + workaround documented [https://github.com/anegostudios/vsmodexamples/issues/11 here]. | ||
| Line 26: | Line 25: | ||
== Install Development Tool == <!--T:8--> | == Install Development Tool == <!--T:8--> | ||
VintageStory is developed in C#. Choose one of the above IDEs or other alternatives. We suggest using '''Visual Studio Community''' for Windows. For Linux you may want to use '''Visual Studio Code''', '''Rider''' or '''MonoDevelop'''. | VintageStory is developed in C#. Choose one of the above IDEs or other alternatives. We suggest using '''Visual Studio Community''' for Windows. For Linux you may want to use '''Visual Studio Code''', '''Rider''' or '''MonoDevelop'''. | ||
After you download an IDE, you can now either get the [https://github.com/anegostudios/vsmodtemplate mod template] project or manually set up a mod project. The mod template offers a convenience tool to set up multiple mod projects and to quickly pack up and have a ready-to-ship mod. | After you download an IDE, you can now either get the [https://github.com/anegostudios/vsmodtemplate mod template] project or manually set up a mod project. The mod template offers a convenience tool to set up multiple mod projects and to quickly pack up and have a ready-to-ship mod. | ||
=== Installation Guide on Windows / macOS with Visual Studio === | === Installation Guide on Windows / macOS with Visual Studio === | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 52: | Line 48: | ||
=== Installation Guide on Linux / macOS with MonoDevelop === <!--T:10--> | === Installation Guide on Linux / macOS with MonoDevelop === <!--T:10--> | ||
You can use the MonoDevelop IDE to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | You can use the MonoDevelop IDE to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 87: | Line 81: | ||
|} | |} | ||
=== Installation Guide on Linux / macOS with Visual Studio Code === | === Installation Guide on Linux / macOS with Visual Studio Code === | ||
You can use Visual Studio Code to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | You can use Visual Studio Code to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 128: | Line 120: | ||
|} | |} | ||
=== Installation Guide on Windows / Linux / macOS with JetBrains Rider === | === Installation Guide on Windows / Linux / macOS with JetBrains Rider === | ||
You can use Jetbrains Rider to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | You can use Jetbrains Rider to make VS mods on Linux. The download instructions are below, choose your distro and follow the link to add the repo, then run the install command. | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
