You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: auditing-process.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,9 @@ Anyone! The people auditing mods are volunteers, and all help is appreciated.
15
15
- At least one (preferably more) approval from a reviewer is mandatory before merging
16
16
- Mod authors cannot approve their own mods
17
17
18
+
## Guidelines
19
+
Submissions must follow all [guidelines].
20
+
18
21
## Binary Inspection
19
22
20
23
The mod binary must be inspected in a decompiler for [malicious] code and other disallowed behavior.
@@ -79,6 +82,7 @@ Poorly-known third-party libraries from unknown authors need auditing.
79
82
If you see something in a mod you're uncertain about, please don't hesitate to ask for a second opinion. Don't approve a submission unless you're 100% certain it's safe.
Copy file name to clipboardExpand all lines: index.md
+1-2Lines changed: 1 addition & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: Neos Mod Loader
6
6
[NeosModLoader] is a mod loading [plugin] for [NeosVR].
7
7
It also contains some extra magic to still let you hang out with other people that might not have the plugin, as usually having different plugins means you can't connect to the same sessions.
8
8
9
-
You can find the source code and release builds of it [from Github][NeosModLoader].
9
+
You can find the source code and release builds of it [on Github][NeosModLoader].
10
10
11
11
## Finding mods
12
12
@@ -30,5 +30,4 @@ The [mod list] is automatically generated from a machine-readable [mod manifest]
- Don't insert your mod at the very end of the file, as you'll have to add a comma to the mod preceding you which can confuse git. Instead, put new mods at the top of the file (or anywhere really).
9
+
- Try not to move things around unnecessarily, as it will generate a larger diff and make reviewing your PR harder.
10
+
- Take care not to mess up the indentation. While it may not seem like a big deal, not enforcing consistent indentation would result in absolute chaos.
11
+
- For security reasons the automatic checks won't run on your first PR until a contributor manually triggers them. Your subsequent PRs will benefit from automatic whitespace and schema validation checks.
12
+
13
+
## Creating a PR
14
+
15
+
There are multiple ways to make a GitHub PR. We'll cover a few approaches.
16
+
17
+
### GitHub Web UI
18
+
19
+
Pros:
20
+
21
+
- You don't need to install any software
22
+
- Requires the least git knowledge of any method
23
+
24
+
Cons:
25
+
26
+
- The web editor isn't very good
27
+
- No schema validation
28
+
- No automatic indentation fixer
29
+
30
+
Simply edit manifest.json via the [GitHub Web Editor](https://github.com/neos-modding-group/neos-mod-manifest/edit/master/manifest.json).
31
+
32
+
### Local Text Editor (Like Visual Studio Code)
33
+
34
+
Pros:
35
+
36
+
- Can validate json schema
37
+
- Can fix bad indentation
38
+
- There are some very good text editors available
39
+
40
+
Cons:
41
+
42
+
- Requires some git know-how
43
+
- Requires you to install software
44
+
45
+
Teaching git is out of scope of this document, but it really is worth learning. Perhaps take a look at the [Git website](https://git-scm.com/).
46
+
47
+
1. Install [Visual Studio Code](https://code.visualstudio.com/)
48
+
2.[Fork](https://github.com/neos-modding-group/neos-mod-manifest/fork) the manifest
49
+
3.[Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your manifest fork ([git clone docs](https://git-scm.com/docs/git-clone))
12. Head back to the [manifest repo](https://github.com/neos-modding-group/neos-mod-manifest), where you should now see a button to open a PR. If not, you can manually [create a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Copy file name to clipboardExpand all lines: submission-tutorial.md
+51-10Lines changed: 51 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,30 @@ layout: page
3
3
title: Submission Tutorial
4
4
---
5
5
6
-
Create a new pull request adding a new mod definition to the [manifest]. (If you're new to GitHub, they have a simple [web editor][github web pull request] for pull requests). An example mod definition is provided below. Note that comments are not allowed in JSON and are only provided here for your reference.
6
+
## How to Make a Submission
7
+
8
+
Create a new pull request to [manifest.json] adding your new mod. Once your pull request is created, community members will review your submission as per the [mod auditing process].
9
+
10
+
If you're new to git or GitHub, take a look at the [Manifest PR Guide](manifest-pr).
11
+
12
+
## Requirements
13
+
14
+
A full list of submission requirements is available [here][mod submission guidelines], but here are the important ones for submitting your first mod:
15
+
16
+
- Follow the [schema]. We have automatic validation on GitHub PRs to check this.
17
+
- Don't ruin the whitespace (indent using four spaces!) We have automatic validation on GitHub PRs to check this.
18
+
- Include a valid SHA-256 hash for your mod. If you don't have a SHA-256 tool on your PC, a [web tool like this][sha256 online] may help.
19
+
- Don't remove existing manifest entries. Deprecate them instead using the `deprecated`[flag].
20
+
- Pick a category from the [category list][categories]. If you're uncertain, check how [other mods][mod list] are categorized.
21
+
22
+
23
+
An example mod definition is provided below. Note that comments are not allowed in JSON and are only provided here for your reference.
7
24
8
25
```js
9
26
"dev.zkxs.examplemod": { // GUID for your mod. This MUST be unique.
10
27
"name":"Example Mod", // Your mod's name
11
28
"description":"Doesn't do anything", // Short description of your mod's functionality
12
-
"category":"For Mod Developers", // The category that best fits your mod.
29
+
"category":"Misc", // The category that best fits your mod.
13
30
"website":"https://github.com/zkxs/ExampleMod", // your mod's homepage
14
31
"sourceLocation":"https://github.com/zkxs/ExampleMod", // where your source code is hosted
15
32
"authors": { // note that you can have more than one author!
@@ -31,20 +48,44 @@ Create a new pull request adding a new mod definition to the [manifest]. (If you
31
48
}
32
49
```
33
50
34
-
If you're trying to figure out how to get the sha256 hash, a [web tool like this][sha256 online] may help.
35
-
36
-
Some of these fields are optional, and some rarely-used fields are omitted from this example. Consult the [schema] for more details.
51
+
Here is the same JSON again, but this time ready for copy/pasting into the manifest. Just update the fields to match your mod.
0 commit comments