Zynh0722/CommandReference
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Zynh0722 2024-02-06 14:27:39 -08:00
parent b075fe371c
commit 060f5c670b
1 changed files with 20 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,34 +1,26 @@
> ⚠️ **Don't click Fork!**
>
> This is a GitHub Template repo. If you want to use this for a plugin, just [use this template][new-repo] to make a new repo!
>
> ![image](https://github.com/goatcorp/SamplePlugin/assets/16760685/d9732094-e1ed-4769-a70b-58ed2b92580c)
# SamplePlugin
# CommandReference
[![Use This Template badge](https://img.shields.io/badge/Use%20This%20Template-0?logo=github&labelColor=grey)][new-repo]
Simple example plugin for Dalamud.
This is not designed to be the simplest possible example, but it is also not designed to cover everything you might want to do. For more detailed questions, come ask in [the Discord](https://discord.gg/holdshift).
## Main Points
* Simple functional plugin
* Slash command
* Main UI
* Settings UI
* Image loading
* Plugin json
* Simple, slightly-improved plugin configuration handling
* Project organization
* Copies all necessary plugin files to the output directory
* Does not copy dependencies that are provided by dalamud
* Output directory can be zipped directly and have exactly what is required
* Hides data files from visual studio to reduce clutter
* Also allows having data files in different paths than VS would usually allow if done in the IDE directly
- Simple functional plugin
- Slash command
- Main UI
- Settings UI
- Image loading
- Plugin json
- Simple, slightly-improved plugin configuration handling
- Project organization
- Copies all necessary plugin files to the output directory
- Does not copy dependencies that are provided by dalamud
- Output directory can be zipped directly and have exactly what is required
- Hides data files from visual studio to reduce clutter
- Also allows having data files in different paths than VS would usually allow if done in the IDE directly
The intention is less that any of this is used directly in other projects, and more to show how similar things can be done.
@ -48,10 +40,10 @@ Be sure to also check out the [Dalamud Developer Docs][dalamud-docs] for helpful
SamplePlugin assumes all the following prerequisites are met:
* XIVLauncher, FINAL FANTASY XIV, and Dalamud have all been installed and the game has been run with Dalamud at least once.
* XIVLauncher is installed to its default directories and configurations.
* If a custom path is required for Dalamud's dev directory, it must be set with the `DALAMUD_HOME` environment variable.
* A .NET Core 7 SDK has been installed and configured, or is otherwise available. (In most cases, the IDE will take care of this.)
- XIVLauncher, FINAL FANTASY XIV, and Dalamud have all been installed and the game has been run with Dalamud at least once.
- XIVLauncher is installed to its default directories and configurations.
- If a custom path is required for Dalamud's dev directory, it must be set with the `DALAMUD_HOME` environment variable.
- A .NET Core 7 SDK has been installed and configured, or is otherwise available. (In most cases, the IDE will take care of this.)
### Building
@ -62,9 +54,9 @@ SamplePlugin assumes all the following prerequisites are met:
### Activating in-game
1. Launch the game and use `/xlsettings` in chat or `xlsettings` in the Dalamud Console to open up the Dalamud settings.
* In here, go to `Experimental`, and add the full path to the `SamplePlugin.dll` to the list of Dev Plugin Locations.
- In here, go to `Experimental`, and add the full path to the `SamplePlugin.dll` to the list of Dev Plugin Locations.
2. Next, use `/xlplugins` (chat) or `xlplugins` (console) to open up the Plugin Installer.
* In here, go to `Dev Tools > Installed Dev Plugins`, and the `SamplePlugin` should be visible. Enable it.
- In here, go to `Dev Tools > Installed Dev Plugins`, and the `SamplePlugin` should be visible. Enable it.
3. You should now be able to use `/pmycommand` (chat) or `pmycommand` (console)!
Note that you only need to add it to the Dev Plugin Locations once (Step 1); it is preserved afterwards. You can disable, enable, or load your plugin on startup through the Plugin Installer.