Skip to content

Commit

Permalink
Refine ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
Slackadays authored Sep 10, 2021
1 parent 8a5b0e9 commit 10b245e
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ A versatile, high-performance Minecraft server startup script suite.
Most Minecraft server startup scripts are either overly simplistic shell scripts or systemd services. Some utilities let you create a custom shell script for your server, but then you have to go a website and enter your server's information, copy that script, download it to the server, and more. Yuck! This "script" is a little different; it provides more features and is blazing fast thanks to its compiled nature.

# Requirements
There are a couple prerequisites. You'll need a POSIX-compliant system such as Linux or FreeBSD or MacOS. Hajime was originally designed to be used with servers that have all server info on an external mass storage device such as a USB flash drive, although this feature is now optional. Your system will also need to have g++ available for installation (this requirement is coming in a futue release).
There are a couple prerequisites. You'll need a POSIX-compliant system such as Linux or FreeBSD or MacOS. Hajime was originally designed to be used with servers that have all server info on an external mass storage device such as a USB flash drive, but this feature is optional. Also, to use the one-step installation option, your platform will need to support Git and G++.

# Why C++?
I decided to make this script in C++ to help me learn it, as well as get at least acceptable performance no matter how many features I add.
There's also a lot of libraries available for C++ and that might be an advantage over something like shell script.
There's also a lot of standard libraries available for C++ and that might be an advantage over something like shell script.

# What's up With That Name?
"Hajime" is just "begin" in Japanese. I know this because I hear it every time I train with my judo instructor.
"Hajime" is "begin" in Japanese. I know this because I hear it every time I train with my judo instructor.

# Quick Start
Run this command to install Hajime in one step.
Use this command to install Hajime in one step.

curl -o install.sh https://raw.githubusercontent.com/Slackadays/Hajime/master/install.sh && sudo sh install.sh

Before running, make sure to review the install.sh file to check for any malicious commands.
Like with all shel scripts, before running, make sure to review the install.sh file to check for any potentially malicious commands.

# Instructions (WIP)
If you are using a precompiled binary, stay in this section. If you are compiling, skip this section. Download the version appropriate for your platform. Next, place it in a simple, memorable location. In my own server, I use /media. Now, run
Expand Down Expand Up @@ -53,6 +53,3 @@ and substitute "hajime" if you have renamed the systemd service file. This will

# Troubleshooting
If Hajime seems to not work after it's been running for a while, just restart it. This solves 99% of problems!

# How It Works
Hajime is a fairly simple program, all things considered. It starts by performing file checks followed by a scan of the /proc virtual filesystem to get a maximum PID. This is done for optimization. Then, a device is mounted (if set to do so) and the specified command is run. A perpetual check of /proc is now done to search for a PID that has a particular keyword in it. If the Minecraft server stops, then the keyword is no longer present and the cycle starts over again.

0 comments on commit 10b245e

Please sign in to comment.