Skip to content

Commit d056a5b

Browse files
committed
Add common CyclopsMC files
1 parent 1118836 commit d056a5b

27 files changed

Lines changed: 862 additions & 307 deletions

.github/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
**:tada: Thanks you for taking the time to contribute to this repository! :tada:**
2+
3+
Issues can be created for bugs :bug:, feature suggestions :heavy_plus_sign:, performance issues :snail:, questions :question: or anything else.
4+
All issues should follow the provided template when creating a new issue.
5+
6+
Before opening new issues, make sure that the issue does not already exist, so search through all issues (even the closed ones) before opening a new issue.
7+
8+
### Performance issues :snail:
9+
10+
If you encounter a performance issue (i.e. server/client lag), make sure to read the following.
11+
12+
You can use the [Sampler mod](https://forum.industrial-craft.net/thread/10820) for _profiling_ your game.
13+
This mod can create `.nps` files, and can help us to see what parts of the game cause performance issues using software such as [VisualVM](https://visualvm.github.io/).
14+
When opening a performance issue, make sure to send us this `.nps` file.
15+
16+
If you are encountering client lag (FPS issues), run this mod in your client.
17+
If you are encountering server lag (TPS issues), run this mod on your server.
18+
19+
When the lag is starting, run `/sampler start` to start profiling, and `/sampler stop` to stop.
20+
Run `/sampler export [your file name]` to export this profiling result to an `.nps` file.
21+
22+
Download Sampler for Minecraft 1.12: http://files.player.to/sampler-1.73.jar
23+
24+
### Pull Request
25+
26+
Pull requests are more than welcome! Before submitting one, make sure to discuss your plans with the maintainers via an issue.
27+
When you submit PRs, you have to sign the [Cyclops Contributor License Agreement](https://cla-assistant.io/CyclopsMC/CyclopsCore),
28+
which makes sure that you give us the appropriate permissions to use your submission, and that your submission is not owned by someone else.

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
patreon: kroeser

.github/ISSUE_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!--Thanks in advance for this issue, you're awesome! Please fill in the following template and make sure your title clear and concisely summarizes the issue.-->
2+
3+
<!---
4+
Thanks for filing an issue! Before you submit, please read the following:
5+
6+
Check the other issue templates if you are trying to submit a bug report, feature request, performance issue, or question
7+
Search open/closed issues before submitting since someone might have asked the same thing before!
8+
-->
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: "🐛 Bug report"
3+
about: If something is not working as expected or crashes
4+
5+
---
6+
7+
<!--Thanks in advance for this issue, you're awesome!-->
8+
<!--Before you read any further, can you double-check to make sure you're using the latest versions of all related mods?-->
9+
<!--Please fill in the following template and make sure your title clear and concisely summarizes the issue.-->
10+
11+
#### Issue type:
12+
13+
- :bug: Bug <!--Don't change this issue type!-->
14+
15+
____
16+
17+
#### Short description:
18+
19+
<!--A clear and concise description of what the bug is.-->
20+
21+
#### Steps to reproduce the problem:
22+
23+
<!--Make sure that the steps are simple, and can be easily and fully followed by other people-->
24+
25+
1. ...
26+
27+
#### Expected behaviour:
28+
29+
<!--A clear and concise description of what you expected to happen.-->
30+
31+
____
32+
33+
#### Versions:
34+
35+
<!--Exact versions of the following mods, not just *latest*.-->
36+
37+
- This mod:
38+
- Minecraft:
39+
- Forge:
40+
41+
<!--WHEN USING MODPACKS: First report this bug to the modpack author! As it could be a configuration or mod conflict issue.-->
42+
<!--Before reporting, make sure to try reproducing without any other mods installed.-->
43+
<!--If this problem only occurs in combination with other mods, attempt to find the smallest set of mods that causes the problem.-->
44+
45+
#### Log file:
46+
47+
<!--Always required for crashes. For other bugs, we might ask for it.-->
48+
<!--Don't paste contents here directly, but use something like http://pastebin.com/-->
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: "➕ Feature request"
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
<!--Thanks in advance for this issue, you're awesome!-->
8+
<!--Please fill in the following template and make sure your title clear and concisely summarizes the issue.-->
9+
10+
#### Issue type:
11+
12+
- :heavy_plus_sign: Feature request <!--Don't change this issue type!-->
13+
14+
____
15+
16+
#### Short description:
17+
18+
<!--A clear and concise description of what you want to happen.-->
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: "🐌 Performance issue"
3+
about: An issue with the performance of this mod, such as abnormal lag.
4+
5+
---
6+
7+
<!--Thanks in advance for this issue, you're awesome!-->
8+
<!--Before you read any further, can you double-check to make sure you're using the latest versions of all related mods?-->
9+
<!--Please fill in the following template and make sure your title clear and concisely summarizes the issue.-->
10+
11+
#### Issue type:
12+
13+
- :snail: Performance issue <!--Don't change this issue type!-->
14+
15+
____
16+
17+
#### Short description:
18+
19+
<!--A clear and concise description of what the issue is.-->
20+
21+
#### Steps to reproduce the problem:
22+
23+
<!--Make sure that the steps are simple, and can be easily and fully followed by other people-->
24+
25+
1. ...
26+
27+
____
28+
29+
#### Versions:
30+
31+
<!--Exact versions of the following mods, not just *latest*.-->
32+
33+
- This mod:
34+
- Minecraft:
35+
- Forge:
36+
37+
#### Profiler output:
38+
39+
<!--Information on how to profile your game: https://github.com/CyclopsMC/CyclopsCore/blob/master-1.18/.github/CONTRIBUTING.md#performance-issues-snail-->
40+

.github/ISSUE_TEMPLATE/Question.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: "❓ Question"
3+
about: A general question
4+
5+
---
6+
7+
<!--Thanks in advance for this issue, you're awesome!-->
8+
<!--Please fill in the following template and make sure your title clear and concisely summarizes the issue.-->
9+
10+
#### Issue type:
11+
12+
- :question: Question <!--Don't change this issue type!-->
13+
14+
____
15+
16+
#### Question:
17+
18+
<!--A clear and concisely formulated question.-->

.github/issue-commenter.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
labels:
2+
- name: bug
3+
labeled:
4+
issue:
5+
body: Thanks for reporting!
6+
- name: feature
7+
labeled:
8+
issue:
9+
body: Thanks for the suggestion!
10+
- name: feature-long-term
11+
labeled:
12+
issue:
13+
body: Thanks for the suggestion!
14+
- name: performance
15+
labeled:
16+
issue:
17+
body: Thanks for reporting!
18+
- name: question
19+
labeled:
20+
issue:
21+
body: Someone will answer your question soon. In the meantime, you might be able to get help more quickly on our [Discord server](https://discord.gg/9yDxubB).
22+
- name: invalid-template
23+
labeled:
24+
issue:
25+
body: '@{{ issue.user.login }} Your issue appears to be not following one of the allowed issue templates, which breaks our automation tools. Please update your issue to the proper template.'

.github/labeler.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
bug:
2+
- '- :bug: Bug'
3+
feature-long-term:
4+
- '- :heavy_plus_sign: Feature request'
5+
performance:
6+
- '- :snail: Performance issue'
7+
question:
8+
- '- :question: Question'
9+
10+
mc-1.12:
11+
- 'Minecraft: 1.12'
12+
mc-1.14:
13+
- 'Minecraft: 1.14'
14+
mc-1.15:
15+
- 'Minecraft: 1.15'
16+
mc-1.16:
17+
- 'Minecraft: 1.16'
18+
mc-1.18:
19+
- 'Minecraft: 1.18'
20+
mc-1.19:
21+
- 'Minecraft: 1.19'

.github/no-response.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configuration for probot-no-response - https://probot.github.io/apps/no-response/
2+
3+
# Number of days of inactivity before an Issue is closed for lack of response
4+
daysUntilClose: 14
5+
# Label requiring a response
6+
responseRequiredLabel: more-information-needed
7+
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
8+
closeComment: >
9+
This issue has been automatically closed because there has been no response
10+
to our request for more information from the original author. With only the
11+
information that is currently in the issue, we don't have enough information
12+
to take action. Please reach out if you have or find the answers we need so
13+
that we can investigate further.

0 commit comments

Comments
 (0)