Rename to Pixi

This commit is contained in:
NGnius (Graham) 2020-05-08 20:30:31 -04:00
parent a6ac0eb6a3
commit 552bc364ba
4 changed files with 26 additions and 24 deletions

View file

@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16 # Visual Studio Version 16
VisualStudioVersion = 16.0.29609.76 VisualStudioVersion = 16.0.29609.76
MinimumVisualStudioVersion = 10.0.40219.1 MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HelloModdingWorld", "HelloModdingWorld\HelloModdingWorld.csproj", "{E0EEA15D-AB3C-4C73-A000-C49B5AE9EA66}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Pixi", "Pixi\Pixi.csproj", "{E0EEA15D-AB3C-4C73-A000-C49B5AE9EA66}"
EndProject EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution

View file

@ -4,15 +4,15 @@ using IllusionPlugin;
// using GamecraftModdingAPI; // using GamecraftModdingAPI;
using GamecraftModdingAPI.Commands; using GamecraftModdingAPI.Commands;
namespace HelloModdingWorld namespace Pixi
{ {
public class MyPlugin : IPlugin // the Illusion Plugin Architecture (IPA) will ignore classes that don't implement IPlugin' public class MyPlugin : IPlugin // the Illusion Plugin Architecture (IPA) will ignore classes that don't implement IPlugin'
{ {
public string Name { get; } = Assembly.GetExecutingAssembly().GetName().Name; // HelloModdingWorld by default public string Name { get; } = Assembly.GetExecutingAssembly().GetName().Name; // Pixi by default
// To change the name, change the project's name // To change the name, change the project's name
public string Version { get; } = Assembly.GetExecutingAssembly().GetName().Version.ToString(); // 0.0.1 by default public string Version { get; } = Assembly.GetExecutingAssembly().GetName().Version.ToString(); // 0.0.1 by default
// To change the version, change <Version>0.0.1</Version> in HelloModdingWorld.csproj // To change the version, change <Version>0.0.1</Version> in Pixi.csproj
private static readonly string helloWorldCommandName = "HelloWorld"; // command name private static readonly string helloWorldCommandName = "HelloWorld"; // command name

View file

@ -3,10 +3,10 @@
<PropertyGroup> <PropertyGroup>
<TargetFramework>net472</TargetFramework> <TargetFramework>net472</TargetFramework>
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects> <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
<Version>0.0.1</Version> <Version>0.1.0</Version>
<Authors>Me</Authors> <Authors>NGnius</Authors>
<PackageLicenseExpression>MIT</PackageLicenseExpression> <PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://git.exmods.org/modtainers/HelloModdingWorld</PackageProjectUrl> <PackageProjectUrl>https://git.exmods.org/NGnius/Pixi</PackageProjectUrl>
<NeutralLanguage>en-CA</NeutralLanguage> <NeutralLanguage>en-CA</NeutralLanguage>
</PropertyGroup> </PropertyGroup>

View file

@ -1,32 +1,34 @@
# HelloModdingWorld # Pixi
Shell project for Gamecraft mods. Gamecraft mod for converting images into coloured blocks.
Use this as a quick-start project structure for your own mods, or to learn how modding works. Think of it like automatic pixel art.
## Setup ## Installation
To install the Pixi mod, copy the build's `Pixi.dll` into the `Plugins` folder in Gamecraft's main folder.
## Development
Show your love by offering your time.
### Setup
Pixi's development environment is similar to most Gamecraft mods, since it's based on HelloModdingWorld's configuration.
This project requires most of Gamecraft's `.dll` files to function correctly. This project requires most of Gamecraft's `.dll` files to function correctly.
Most, but not all, of these files are stored in Gamecraft's `Gamecraft_Data\Managed` folder. Most, but not all, of these files are stored in Gamecraft's `Gamecraft_Data\Managed` folder.
The project is pre-configured to look in a folder called ref in the solution's main directory or one level up from that. The project is pre-configured to look in a folder called ref in the solution's main directory or one level up from that.
You can make sure HelloModdingWorld can find all of `.dll` files it needs by copying your Gamecraft folder here and renaming it to `ref`, but you'll have to re-copy it after every Gamecraft update. You can make sure Pixi can find all of `.dll` files it needs by copying your Gamecraft folder here and renaming it to `ref`, but you'll have to re-copy it after every Gamecraft update.
You can also create a symbolic link (look it up) to your Gamecraft install folder named `ref` in this folder to avoid having to re-copy files. You can also create a symbolic link (look it up) to your Gamecraft install folder named `ref` in this folder to avoid having to re-copy files.
For any mod to work, you will have to patch your game with [GCIPA](https://git.exmods.org/modtainers/GCIPA). Like most mods, you will have to patch your game with [GCIPA](https://git.exmods.org/modtainers/GCIPA).
[Direct link to install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install). Pixi also requires the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) library to be installed (in `ref/Plugins/GamecraftModdingAPI.dll`).
!!Download a release from git.exmods.org not github.com!!
This project also requires the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) library to be installed (in `ref/Plugins/GamecraftModdingAPI.dll`).
[Direct link to install guide](https://www.exmods.org/guides/install.html).
## Building ## Building
After you've completed the setup, open the solution file `HelloModdingWorld.sln` in your prefered C# .NET/Mono development environment. After you've completed the setup, open the solution file `Pixi.sln` in your prefered C# .NET/Mono development environment.
I'd recommend Visual Studio Community Edition or JetBrains Rider for Windows and Monodevelop for Linux. I'd recommend Visual Studio Community Edition or JetBrains Rider for Windows and Monodevelop for Linux.
If you've successfully completed setup, you should be able to build the HelloModdingWorld project without errors. If you've successfully completed setup, you should be able to build the Pixi project without errors.
If it doesn't work and you can't figure out why, ask for help on [our Discord server](https://discord.gg/xjnFxQV). If it doesn't work and you can't figure out why, ask for help on [our Discord server](https://discord.gg/xjnFxQV).
## Installation
To install the HelloModdingWorld mod, copy the build's `HelloModdingWorld.dll` into the `Plugins` folder in Gamecraft's main folder.