Skip to content

Commit 5111029

Browse files
tildejustintildejustin
committed
add templates and readme
0 parents  commit 5111029

File tree

4 files changed

+141
-0
lines changed

4 files changed

+141
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Bug report
3+
about: Use this template if you're running into bugs or other issues
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Read me before you open an issue! ###
11+
12+
#### Instructions
13+
14+
This is a template for the issue you are about to open! It will help you provide the information necessary
15+
to complete your **bug report**. Before you open an issue, ensure you've completed every step on the checklist below.
16+
17+
- Have you used the search tool to find similar issues? Make sure you are not opening a duplicate.
18+
- Are you using the latest version of the mod? If not, try updating to see if it resolves your issue.
19+
20+
All good? Please read through the sections below, and fill out any lines starting with an arrow. Then, remove
21+
everything above this dashed line (including the line itself.)
22+
23+
------------------------
24+
25+
### Version Information
26+
27+
> Replace this text with the exact version of the mod you are using. Every part of the version is important! If you
28+
> do not know what version you are using, look at the file name in your "mods" folder.
29+
30+
### Expected Behavior
31+
32+
> Replace this text with what you expected to happen.
33+
>
34+
> Example: The Piston should extend.
35+
36+
### Actual Behavior
37+
38+
> Replace this text with what actually happened.
39+
>
40+
> Example: The Piston does not extend.
41+
42+
### Reproduction Steps
43+
44+
> Provide information on how to reproduce this game crash. You can either fill this section in like the example below
45+
> or do something else -- just make sure your instructions are minimal and clear, as other people will need to be able
46+
> to replicate your issue.
47+
>
48+
> Example:
49+
> 1. Place a Redstone Lamp in front of a Redstone Repeater
50+
> 2. Use a Lever to activate the Redstone Repeater
51+
> 3. Nothing happens
52+
53+
### System Information
54+
55+
> You can obtain this information from the right-side of the in-game debug screen (F3) or through using DxDiag
56+
> (https://support.microsoft.com/en-us/help/4028644/windows-open-and-run-dxdiagexe) on Windows.
57+
>
58+
> - Java Version: [fill me in]
59+
> - CPU: [fill me in]
60+
> - GPU: [fill me in]
61+
62+
### Other Information
63+
64+
> Provide a list of any other mods you are using, along with their respective versions. If you have any screenshots,
65+
> videos, or other information that you feel is necessary to explain the issue, feel free to attach them here.

‎.github/ISSUE_TEMPLATE/crash_report.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Crash report
3+
about: Use this template if your game is crashing or failing to start correctly
4+
title: ''
5+
labels: crash
6+
assignees: ''
7+
8+
---
9+
10+
### Read me before you open an issue! ###
11+
12+
#### Instructions
13+
14+
This is a template for the issue you are about to open! It will help you provide the information necessary
15+
to complete your **crash report**. Before you open an issue, ensure you've completed every step on the checklist below.
16+
17+
- Have you used the search tool to find similar issues? Make sure you are not opening a duplicate.
18+
- Are you using the latest version of the mod? If not, try updating to see if it resolves your issue.
19+
20+
All good? Please read through the sections below, and fill out any lines starting with an arrow. Then, remove
21+
everything above this dashed line (including the line itself.)
22+
23+
------------------------
24+
25+
### Version
26+
27+
> Replace this text with the exact version of the mod you are using. Every part of the version is important! If you
28+
> do not know what version you are using, look at the file name in your "mods" folder.
29+
30+
### Reproduction Steps
31+
32+
> Provide information on how to reproduce this game crash. You can either fill this section in like the example below
33+
> or do something else -- just make sure your instructions are minimal and clear, as other people will need to be able
34+
> to replicate your issue.
35+
>
36+
> Example:
37+
> 1. Place a Redstone Lamp in front of a Redstone Repeater
38+
> 2. Use a Lever to activate the Redstone Repeater
39+
> 3. Nothing happens
40+
41+
### Crash Report File
42+
43+
> Upload your crash report file as an attachment to this issue (drag-and-drop) or to a service such as GitHub
44+
> Gist (paste a link) and replace this section. This information is critical in resolving your issue!
45+
>
46+
> Tip: Messages like "Exit code 0" from your launcher are not what you're looking for. If your launcher does not
47+
> provide a button to view the most recent crash report, check your game's "crash-reports" folder for the most recent
48+
> crash report file.
49+
50+
### Additional Information
51+
52+
> Provide any additional information or context which may be relevant to the issue. If you have none to add,
53+
> you can remove this section.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Description
2+
- Provide a brief overview of your changes
3+
- Call out any interesting implementation details describing _why_ you made specific decisions
4+
5+
Checklist
6+
- [ ] Build compiles and is ready to be automatically be released to the public

‎README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Set Spawn Mod for SSG
2+
3+
Overrides player spawnpoint with specified coordinates
4+
Configurable seeds and coordinates in /config/setspawn.json
5+
Coordinates are validated before overriding
6+
Works with multi using the global config file
7+
8+
Usage
9+
10+
Start Minecraft to generate the local and global config files
11+
You must restart MC after editing the config for changes to go through
12+
The mod will only be active if you're on a seed that exists in the config
13+
Spawn will only be set if the coordinates are naturally rollable
14+
You may add or change as many seeds as you want to the config
15+
16+
**NOTE**: All code is kept on branches specific to Minecraft versions or version ranges.
17+
This branch only exists for documentation and GitHub metadata.

0 commit comments

Comments
 (0)