initial commit
This commit is contained in:
commit
fdf06d1deb
11 changed files with 237 additions and 0 deletions
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
# Disable Git line ending conversion, to prevent packwiz index hashes changing when committing from Windows
|
||||
* -text
|
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
/server-mods
|
44
CONTRIBUTING.md
Normal file
44
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
Thank you for considering contributing to GalacticFactory! To ensure a smooth integration of new mods, please follow this process:
|
||||
|
||||
## Suggesting a New Mod
|
||||
|
||||
1. **Open an Issue:** If you have a mod in mind that you believe would be a valuable addition to our modpack, start by opening an issue in our repository:
|
||||
- Provide a clear and concise title for the issue, indicating that you are suggesting a new mod.
|
||||
- In the issue description, explain the mod's features, mechanics, and how it aligns with the modpack's theme.
|
||||
- If possible, outline how you envision the mod enhancing the overall gameplay experience.
|
||||
|
||||
## Evaluating a New Mod
|
||||
|
||||
2. **Mod Evaluation:** Assess whether the new mod aligns with our modpack's theme and gameplay. Consider the following:
|
||||
- Do we like the mod and its features?
|
||||
- Does the mod enhance the overall experience of the modpack?
|
||||
|
||||
3. **Fit within the Modpack:** Determine if the mod integrates well within the modpack's existing content:
|
||||
- Does the mod's concept and mechanics harmonize with the modpack's theme?
|
||||
- Will adding the mod create a balanced and enjoyable gameplay experience?
|
||||
|
||||
4. **Compatibility:** Examine the mod's compatibility with other mods in the modpack:
|
||||
- Is the mod compatible with the existing mods without major conflicts?
|
||||
- Test interactions between the new mod and others in the modpack.
|
||||
|
||||
5. **Priority:** If there are compatibility issues with other mods, evaluate the importance of the new mod compared to the conflicting one:
|
||||
- Is the new mod's functionality more valuable to the modpack than an incompatible mod?
|
||||
- Consider community preferences and modpack goals.
|
||||
|
||||
## Implementation and Integration
|
||||
|
||||
6. **Mod Integration:** Determine if the mod needs any gating or adjustments to fit seamlessly into the modpack:
|
||||
- Do we need to incorporate gameplay gating (e.g., gamestages) to control mod access?
|
||||
- Are any recipe changes required (using CraftTweaker/KubeJS) for balance or progression?
|
||||
|
||||
7. **Pull Request:** If modifications are needed, create a pull request that implements the necessary changes and resolves the associated issue:
|
||||
- Open a pull request with clear explanations of the changes made.
|
||||
- Reference the issue number in the pull request description.
|
||||
- Ensure the changes address compatibility, gameplay, and integration concerns.
|
||||
|
||||
8. **Direct Addition:** If no further changes are needed, directly add the mod to the main branch and close the issue:
|
||||
- Make a commit on the main branch that adds the new mod files.
|
||||
- Mention the issue number in the commit message to link it.
|
||||
- Close the issue.
|
9
LICENSE
Normal file
9
LICENSE
Normal file
|
@ -0,0 +1,9 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2023 GalacticFactory
|
||||
|
||||
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.
|
138
README.md
Normal file
138
README.md
Normal file
|
@ -0,0 +1,138 @@
|
|||
# GalacticFactory
|
||||
|
||||
## Installation
|
||||
|
||||
Currently, there are only two supported methods of installing the modpack, as it has not been released on Modrinth yet.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3> Installing with Prism Launcher or ATLauncher </h3>
|
||||
</summary>
|
||||
|
||||
Go to the [Releases](https://coastalcommits.com/GalacticFactory/GalacticFactory/releases) page of this repository and download `GalacticFactory - Prism Launcher.zip` or `GalacticFactory - ATLauncher.zip`, depending on your launcher.
|
||||
|
||||
Alternatively, you can use this link in your launcher instead of downloading the zip file manually.
|
||||
|
||||
```markdown
|
||||
# For Prism Launcher
|
||||
https://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/GalacticFactory%20-%20Prism%20Launcher.zip
|
||||
|
||||
# For ATLauncher
|
||||
https://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/GalacticFactory%20-%20ATLauncher.zip
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
View image
|
||||
</summary>
|
||||
|
||||

|
||||
</details>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3> Installing with unsup </h3>
|
||||
<h4> (Other Launchers/Servers) </h4>
|
||||
</summary>
|
||||
|
||||
[unsup](https://github.com/packwiz/packwiz-installer) is a useful tool that lets you automatically install and update a modpack through the [Packwiz](https://packwiz.infra.link/) `pack.toml` file of that pack.
|
||||
|
||||
First, you need to download the `unsup_setup` script compatible with your system.
|
||||
If you're on Windows, use [this link](https://coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.ps1).
|
||||
If you're on Linux or MacOS, use [this link](coastalcommits.com/GalacticFactory/GalacticFactory/releases/download/Pre-Release/unsup_setup.sh).
|
||||
After that, follow the instructions below for your platform:
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h4> Servers </h4>
|
||||
</summary>
|
||||
|
||||
First, move the `unsup_setup` script to your server's root folder (the folder that has your server .jar) and run it, then add the following to your Java Arguments.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
You'll also want to add the following line to your `unsup.ini` file, under `preset=minecraft`.
|
||||
|
||||
```bash
|
||||
no_gui=true
|
||||
```
|
||||
|
||||
After this, I recommend following the post-install guide:
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
✨ Post-install tips and tricks
|
||||
</summary>
|
||||
|
||||
### Pre-loading chunks (Servers)
|
||||
|
||||
I highly recommend pre-loading your chunks so that you can prevent lag when players generate new ones. Chunky is included in AdrenaFactory as of 1.1.2, here are a few basic commands to pre-load with the mod. **Keep in mind that pre-loading can take quite a long time, and you should probably do it when people aren't online**.
|
||||
|
||||
ℹ️ You **must** install [Chunky](https://modrinth.com/project/chunky) to do this.
|
||||
|
||||
Choose the world, replacing `minecraft:overworld` with the corresponding world:
|
||||
|
||||
```markdown
|
||||
chunky world minecraft:overworld
|
||||
```
|
||||
|
||||
Choose the radius to pre-load, replacing 2500 with how much you want to do:
|
||||
|
||||
```markdown
|
||||
chunky radius 2500
|
||||
```
|
||||
|
||||
After choosing the world and the radius, start pre-loading:
|
||||
|
||||
```markdown
|
||||
chunky start
|
||||
```
|
||||
|
||||
</details>
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<h4> Modrinth App </h4>
|
||||
</summary>
|
||||
|
||||
Create a new 1.20.1 Fabric instance, and go to your settings page.
|
||||
|
||||
Then, move the `unsup_setup` file to your instance's `.minecraft` folder and run it. You can click the `Folder` button to open your instance's folder.
|
||||
|
||||
Scroll down in your settings page until you find the `Java` category. Click the `Override global java arguments` button, then put the following argument into your `Java arguments` field.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
Launch the game, and the modpack will automatically download itself and update on launch.
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<h4> Other Launchers </h4>
|
||||
</summary>
|
||||
|
||||
If your launcher supports custom JVM arguments, move the `unsup_setup` file into your instance's `.minecraft` folder and run it, then add the following argument to your JVM arguments.
|
||||
|
||||
```bash
|
||||
-javaagent:unsup.jar
|
||||
```
|
||||
|
||||
If it doesn't, please contact us in our [Discord server](https://invite.galacticfactory.cc/).
|
||||
We do not support the vanilla Minecraft Launcher. If you're looking for a launcher to use, I'd recommend [Prism Launcher](https://prismlauncher.org/).
|
||||
</details>
|
||||
</details>
|
||||
|
||||
## Modifying Optional Content
|
||||
|
||||
This modpack includes some mods and resource packs that are optional. You can turn these on or off in the Unsup Installation GUI.
|
||||
|
||||
- Delete the `.unsup-state.json`file in your `.minecraft`/instance directory.
|
||||
- Make sure you have hidden files set to show up in File Explorer.
|
||||
- Start the game.
|
||||
- Click on the mods you'd like to install. Hovering over a mod's name will show its description. (Image shown is of Packwiz, not Unsup.)
|
||||

|
||||
- Click `OK`. You're done!
|
5
src/index.toml
Normal file
5
src/index.toml
Normal file
|
@ -0,0 +1,5 @@
|
|||
hash-format = "sha256"
|
||||
|
||||
[[files]]
|
||||
file = "unsup.toml"
|
||||
hash = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
|
17
src/pack.toml
Normal file
17
src/pack.toml
Normal file
|
@ -0,0 +1,17 @@
|
|||
name = "GalacticFactory"
|
||||
author = "GalacticFactory"
|
||||
version = "1.0.0"
|
||||
pack-format = "packwiz:1.1.0"
|
||||
|
||||
[index]
|
||||
file = "index.toml"
|
||||
hash-format = "sha256"
|
||||
hash = "523322992e6e661afcbeef8242f835eb9302ba71e4c6ff67256d83426668c71f"
|
||||
|
||||
[versions]
|
||||
minecraft = "1.20.2"
|
||||
neoforge = "20.2.47-beta"
|
||||
unsup = "0.2.0"
|
||||
|
||||
[options]
|
||||
acceptable-game-versions = ["1.20.1"]
|
0
src/unsup.toml
Normal file
0
src/unsup.toml
Normal file
17
unsup.ini
Normal file
17
unsup.ini
Normal file
|
@ -0,0 +1,17 @@
|
|||
version=1
|
||||
source_format=packwiz
|
||||
source=https://coastalcommits.com/GalacticFactory/AdrenaFactory/raw/branch/main/src/pack.toml
|
||||
subtitle=AdrenaFactory Installer
|
||||
preset=minecraft
|
||||
|
||||
[flavors]
|
||||
; Client
|
||||
minimap_mod=journeymap
|
||||
; Server
|
||||
server_minimap_mod=server_journeymap
|
||||
|
||||
[colors]
|
||||
background=313338
|
||||
progress=02b0f1
|
||||
button=02b0f1
|
||||
progress_track=2b2d31
|
2
unsup_setup.ps1
Normal file
2
unsup_setup.ps1
Normal file
|
@ -0,0 +1,2 @@
|
|||
Invoke-WebRequest -OutFile unsup.jar -Uri https://git.sleeping.town/attachments/7edb17a2-e43f-4789-8bae-6140cbe98311
|
||||
Invoke-WebRequest -OutFile unsup.ini -Uri https://coastalcommits.com/GalacticFactory/GalacticFactory/raw/branch/main/unsup.ini
|
2
unsup_setup.sh
Normal file
2
unsup_setup.sh
Normal file
|
@ -0,0 +1,2 @@
|
|||
wget -O unsup.jar https://git.sleeping.town/attachments/7edb17a2-e43f-4789-8bae-6140cbe98311
|
||||
wget -O unsup.ini https://coastalcommits.com/GalacticFactory/GalacticFactory/raw/branch/main/unsup.ini
|
Loading…
Add table
Reference in a new issue