Skip to content

Commit

Permalink
updated readme.md
Browse files Browse the repository at this point in the history
preparing for v1.1
  • Loading branch information
ngdplnk authored Apr 6, 2024
1 parent c52988f commit cc65a16
Showing 1 changed file with 36 additions and 15 deletions.
51 changes: 36 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,49 @@ SSTools4MC is a set of tools designed to assist you hosting your own dedicated M

## Table of Contents
- [Getting Started](#getting-started)
- [Server Launcher](#server-launcher)
- [Windows](#windows)
- [Installation](#installation)
- [Python and Required Modules](#python-and-required-modules)
- [Copyright and Disclaimer](#copyright-and-disclaimer)
- [Important and Acknowledgments](#important-and-acknowledgments)

## Getting Started
To get started with SSTools4MC, follow these steps:

1. Download the latest version of SSTools4MC or you desired tool from the [GitHub Releases](https://github.com/NGDPLNk/SSTools4MC/releases/latest) page.
2. Paste the downloaded executable to your server folder.
1. Download the latest version of SSTools4MC from the [GitHub Releases](https://github.com/NGDPLNk/SSTools4MC/releases/latest) page.
2. Run the installer. A shortcut should be created on your desktop and in your Windows start menu.
3. Enjoy!

## Server Launcher
### Windows
#### Minimum Requirements:
- Operating System: Windows 8 (64-bit - Version 6.2.9200.16384) or newer.
- Processor: 1 core at 1.00GHz; x64 architecture.
- RAM: At least 512MB.
## Installation
### Minimum Requirements:
- Operating System: Windows 10 (64-bit - Version 10.0.14393.6796) or newer. Windows 10 22H2 recommended.
- Processor: 2 cores at 1.00GHz; x64 architecture.
- RAM: At least 1GB.
- Disk Space: Varies depending on the server.
- Python: 3.9 or newer.

Administrator privileges are also required in old releases of SSTools4MC to access server files and folders.

### Python Installation and Required Modules:
1. Download and install Python 3.9 or newer from the [official Python website](https://www.python.org/downloads/). When installing Python, be sure to select the "Add Python to PATH" option.
2. After you successfully installed Python with this option, open a command prompt, powershell or terminal with administrator privileges.
3. Install the required Python modules by running the following commands:
```bash
pip install requests
pip install termcolor
```

### Java Installation:
1. Download the Java 22 installer from the [official Oracle website](https://www.oracle.com/cl/java/technologies/downloads/#jdk22-windows).
2. Run the installer and follow the on-screen instructions to install Java 22.
3. Verify the installation by opening a command prompt, powershell or terminal and running:
```bash
java -version
```

If Java 22 is correctly installed, the command should display the installed Java version.

Java is necessary to your machine to be able to run your Minecraft servers.

## Copyright and Disclaimer
**SSTools4MC and each of its tools are not official Minecraft products and are not endorsed by Mojang.**

Expand All @@ -39,20 +60,20 @@ THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI

Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

NGDPL Nk does not own or store any Mojang Synergies AB products, and the availability of these products is not dependent on NGDPL Nk.
This repository or its owner does not own or store any Mojang Synergies AB products, and the availability of these products is not dependent on him or this repository.

NGDPL Nk does not own or store any Oracle products, and the availability of these products is not dependent on NGDPL Nk.
This repository or its owner does not own or store any Oracle products, and the availability of these products is not dependent on him or this repository.

All Mojang Synergies AB-related elements and names are used in compliance with the [Minecraft Commercial Usage Guidelines](https://www.minecraft.net/en-us/eula/) and [Brand and Asset Usage Guidelines](https://account.mojang.com/terms?ref=ft#brand).

All Oracle-related elements and names are used in compliance with the [Oracle Terms of Use](https://www.oracle.com/legal/terms.html) and [Trademarks](https://www.oracle.com/legal/trademarks.html).

## Important and Acknowledgments
- Administrator privileges are required in old releases of SSTools4MC in order to access server files and folders.
- Releases of SSTools4MC are detected as viruses. You can avoid this by allowing them in your antivirus. Dont worry, there are no viruses here. You can take a look to the source if you still don't believe it.
- Old releases of SSTools4MC and in some cases its installer, are detected as viruses. You can avoid this by allowing them in your antivirus. Dont worry, there are no viruses here. You can take a look to the source if you still don't believe it.
So many thanks to [@naicoooossj](https://github.com/naicoooossj) and [@LegalizeNuclearBombs](https://steamcommunity.com/id/LegalizeNucelarBombs/) :shipit: for helping port the most recent versions of this project to Python, testing, debugging and giving new ideas.
So many thanks to [@naicoooossj](https://github.com/naicoooossj) and [@LegalizeNuclearBombs](https://steamcommunity.com/id/LegalizeNucelarBombs/) :shipit: for testing and giving new ideas to this project.
Thank you for using SSTools4MC!
© 2024 - NGDPL Nk
© 2024 - TLSoftware - NGDPL Nk

0 comments on commit cc65a16

Please sign in to comment.