Initial commit

.github/workflows/wiki-auto.yml

@@ -0,0 +1,17 @@
+name: Wiki Sync (Auto)
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      # Additional steps to generate documentation in "docs/wiki" directory
+      - name: Upload docs/wiki to Wiki
+        uses: SwiftDocOrg/github-wiki-publish-action@v1
+        with:
+          path: "docs/wiki"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

.github/workflows/wiki-manual.yml

@@ -0,0 +1,17 @@
+name: Wiki Sync (Manual)
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      # Additional steps to generate documentation in "docs/wiki" directory
+      - name: Upload docs/wiki to Wiki
+        uses: SwiftDocOrg/github-wiki-publish-action@v1
+        with:
+          path: "docs/wiki"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

.gitignore

@@ -0,0 +1,26 @@
+.build/*.7z
+.build/*.rar
+.build/*.zip
+.build/(old)/*.7z
+.build/(old)/*.rar
+.build/(old)/*.zip
+.build/old/*.7z
+.build/old/*.rar
+.build/old/*.zip
+.idea/(old)/
+.idea/closed/
+.idea/hidden/
+.idea/licensed/
+.idea/old/
+.idea/secret/
+.release/
+build/*.7z
+build/*.rar
+build/*.zip
+build/(old)/*.7z
+build/(old)/*.rar
+build/(old)/*.zip
+build/old/*.7z
+build/old/*.rar
+build/old/*.zip
+release/

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 GroundAura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,12 @@
+# ProjectName
+
+ProjectName is a mod for Skyrim Special Edition created by GroundAura.
+
+This mod can be found on [Nexus Mods](https://www.nexusmods.com/skyrimspecialedition/mods/).
+That is the best place to find installation information, comment, report bugs, and find my contact information.
+
+Releases can also be downloaded on [here on GitHub](https://github.com/GroundAura/Project-Template/releases).
+
+A changelog can be found [here](https://github.com/GroundAura/Project-Template/blob/main/docs/CHANGELOG.md).
+
+Additional information can be found on the [GitHub Wiki](https://github.com/GroundAura/Project-Template/wiki).

build/MO2/ProjectName.zip.meta

@@ -0,0 +1,5 @@
+[General]
+name=ProjectName (pre-release) []
+modName=ProjectName
+installed=false
+uninstalled=false

dist/ProjectName/Base/MCM/Config/ProjectName/config.json

@@ -0,0 +1,20 @@
+{
+"$schema": "https://raw.githubusercontent.com/Exit-9B/MCM-Helper/main/docs/config.schema.json",
+"modName": "ProjectName",
+"displayName": "$ProjectName_MCM",
+"minMcmVersion": 13,
+"pluginRequirements": [ "ProjectName.esp" ],
+"cursorFillMode": "topToBottom",
+"pages": [
+	{
+		"pageDisplayName": "$ProjectName_MCM_Page1",
+		"cursorFillMode": "topToBottom",
+		"content": [
+			{
+				"text": "$ProjectName_MCM_Heading1",
+				"type": "header"
+			}
+		]
+	}
+]
+}

dist/ProjectName/Base/scripts/source/ProjectNameMCM.psc

@@ -0,0 +1 @@
+Scriptname ProjectNameMCM extends MCM_ConfigBase

docs/CHANGELOG.md

@@ -0,0 +1,5 @@
+# ProjectName - Changelog
+
+## Version 1.0.0
+
+- **Initial release.**

docs/description-md/description.md

@@ -0,0 +1,165 @@
+# \[center\]**\[color=#ffd966\]ProjectName\[/color\]**\[/center\]
+
+## \[center\]**\[color=#93c47d\]Subtitle\[/color\]**\[/center\]
+
+\[center\][![kofi](https://github.com/doodlum/nexusmods-widgets/blob/main/Ko-fi_40px_60fps.png?raw=true)](https://ko-fi.com/groundaura)          [![linktree](https://i.imgur.com/jOQE4n8.png)](https://linktr.ee/groundaura)          [![discord](https://github.com/doodlum/nexusmods-widgets/blob/main/Discord_40px.png?raw=true)](https://discord.gg/zft8DmbfKv)\[/center\]
+
+---
+
+## \[center\]**\[color=#ffd966\]Overview\[/color\]**\[/center\]
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+---
+
+## \[center\]**\[color=#ffd966\]Features\[/color\]**\[/center\]
+
+### **\[color=#93c47d\]Feature 1\[/color\]**
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+### **\[color=#93c47d\]Feature 2\[/color\]**
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+### **\[color=#93c47d\]Feature 3\[/color\]**
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+---
+
+## \[center\]**\[color=#ffd966\]Installation\[/color\]**\[/center\]
+
+Install ProjectName and its requirements with your choice of mod manager. Overwrite any other files if asked. Let me know if you have any problems.
+
+### **\[color=#93c47d\]Hard Requirements:\[/color\]**
+
+- [ModName](https://www.nexusmods.com/skyrimspecialedition/mods/) v1.0.0+.
+
+### **\[color=#93c47d\]Soft Requirements:\[/color\]**
+
+- [ModName](https://www.nexusmods.com/skyrimspecialedition/mods/) v1.0.0+ – Conditions.
+
+### **\[color=#93c47d\]Asset Load Order\[/color\]**
+
+**(MO2 Left Pane or Vortex Mods Page)**
+
+Make sure that ProjectName takes priority over any other mod that includes the same files.
+
+OR
+
+Order shouldn't matter because all this mods' file are unique.
+
+OR
+
+Order shouldn't matter because any other mods that include the same files should be identical.
+
+### **\[color=#93c47d\]Plugin Load Order\[/color\]**
+
+**(MO2 Right Pane or Vortex Plugins Page)**
+
+Make sure that `ProjectName.esp` loads after `Example.esp`.
+
+OR
+
+Load order doesn't matter.
+
+---
+
+## \[center\]**\[color=#ffd966\]Compatibility\[/color\]**\[/center\]
+
+---
+
+## \[center\]**\[color=#ffd966\]Recommendations\[/color\]**\[/center\]
+
+- [ModName](https://www.nexusmods.com/skyrimspecialedition/mods/) by [AuthorName](https://www.nexusmods.com/skyrimspecialedition/users/97658973).
+
+---
+
+## \[center\]**\[color=#ffd966\]FAQ\[/color\]**\[/center\]
+
+### **\[color=#93c47d\]Q1: What versions are supported?\[/color\]**
+
+This mod is not version dependant as it doesn't have any SKSE plugins. Some required mods may be version dependant, so you'll have to install the correct versions and those mods may need to be updated if Skyrim gets any breaking updates in the future. It should work on any version of Skyrim including SE/AE/GOG/v1.5.x/v1.6.x/VR, but it hasn't been tested on every version. Oldrim and console are not supported, but you're welcome to try to port it yourself (see permissions).
+
+### **\[color=#93c47d\]Q2: Does this take plugin slots?\[/color\]**
+
+No .esp/.esm/.esl plugins are included.
+
+OR
+
+All plugins included are .esl or .esp/.esm with the ESL flag.
+
+### **\[color=#93c47d\]Q3: Does installing/updating/uninstalling on an existing save work?\[/color\]**
+
+As far as I know it should be fine. However, when changing any mods at all midplaythrough, consider following good modding practices such as making backups, using tools like [ReSaver](https://www.nexusmods.com/skyrimspecialedition/mods/5031), and using bugfix/stability mods like [Save Unbaker](https://www.nexusmods.com/skyrimspecialedition/mods/85565) ([VR](https://www.nexusmods.com/skyrimspecialedition/mods/86265)).
+
+---
+
+## **\[color=#ffd966\]Credits\[/color\]**
+
+[spoiler]
+
+### **\[color=#93c47d\]Assets:\[/color\]**
+
+- Asset
+
+  - Author: [AuthorName](https://www.nexusmods.com/skyrimspecialedition/users/)
+
+  - License: [LicenseName](https://creativecommons.org/publicdomain/zero/1.0)
+
+### **\[color=#93c47d\]Mods Referenced:\[/color\]**
+
+- [ModName](https://www.nexusmods.com/skyrimspecialedition/mods/) by [AuthorName](https://www.nexusmods.com/skyrimspecialedition/users/97658973).
+
+### **\[color=#93c47d\]Modpage Resources:\[/color\]**
+
+- Font from [Sovngarde - A Nordic Font](https://www.nexusmods.com/skyrimspecialedition/mods/386) by [Koveich](https://www.nexusmods.com/skyrimspecialedition/users/34763925).
+
+- Icon from [SkyUI](https://www.nexusmods.com/skyrimspecialedition/mods/12604) by [psychosteve](https://www.nexusmods.com/skyrim/users/37741).
+
+- Widgets from [nexusmods-widgets](https://github.com/doodlum/nexusmods-widgets) by [doodlum](https://www.nexusmods.com/skyrimspecialedition/users/28038035).
+
+### **\[color=#93c47d\]Tools Used:\[/color\]**
+
+- [Alphabetize Tool](https://wordcounter.net/alphabetize)
+
+- [Champollion](https://github.com/Orvid/Champollion/releases)
+
+- [Converting Colors](https://convertingcolors.com)
+
+- [Creation Kit](https://store.steampowered.com/app/1946180/Skyrim_Special_Edition_Creation_Kit)
+
+- [Everything](https://www.voidtools.com)
+
+- [FOMOD Creation Tool](https://www.nexusmods.com/fallout4/mods/6821)
+
+- [GIMP](https://www.gimp.org)
+
+- [GitHub Desktop](https://desktop.github.com)
+
+- [Inkscape](https://inkscape.org)
+
+- [JPEXS Free Flash Decompiler](https://github.com/jindrapetrik/jpexs-decompiler/releases)
+
+- [md2nexus](https://www.nexusmods.com/skyrimspecialedition/mods/100441)
+
+- [mdigi tools color](https://mdigi.tools/color)
+
+- [Notepad++](https://notepad-plus-plus.org/downloads)
+
+- [Papyrus Compiler App](https://www.nexusmods.com/skyrimspecialedition/mods/23852)
+
+- [SSEEdit](https://www.nexusmods.com/skyrimspecialedition/mods/164)
+
+- [Visual Studio Code](https://code.visualstudio.com)
+
+- [WinMerge](https://winmerge.org)
+
+### **\[color=#93c47d\]Special Thanks To:\[/color\]**
+
+- [AuthorName](https://www.nexusmods.com/skyrimspecialedition/users/97658973) for stuff.
+
+[/spoiler]
+
+## \[center\][\[color=#c27ba0\]**> > > Check Out My Other Mods! < < <**\[/color\]](https://www.nexusmods.com/users/97658973)\[/center\]

docs/description-md/overview.md

@@ -0,0 +1 @@
+ProjectName is a mod that does a thing.

docs/description-md/permissions.md

@@ -0,0 +1,5 @@
+You can use any assets included in this project as long as you follow the licensing and permissions of the original author(s)' of said assets.
+
+Any assets made solely by me are free to use for whatever, barring pay walling. Reasonable credits for my efforts are appreciated but not required.
+
+Contact me for questions or clarification.