Skip to content

Last bit needs edited out, and the directory listing could use fleshing out #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
Sure, I can definitely help you write a tutorial on this. First, I'll go through the basic steps of using Git, followed by instructions on how to use the specific repository with a Minetest server. For this tutorial, I'm assuming that the person has access to a terminal/command line and has Minetest installed on their machine. If Minetest isn't installed yet, you can find instructions on the [Minetest official website](https://www.minetest.net/downloads/).

# Part 1: Introduction to Git

## Step 1: Install Git

If Git is not yet installed, you will need to install it. The exact method depends on your operating system:

- On Ubuntu or other Debian-based Linux distributions, use the command: `sudo apt-get install git`
- On Fedora, use the command: `sudo dnf install git`
- On Windows, download the installer from the [Git website](https://git-scm.com/download/win)
- On macOS, you can install git via Homebrew with the command: `brew install git`

## Step 2: Clone the Repository

The next step is to clone the GitHub repository to your local machine. Cloning creates a local copy of the repository on your computer. This allows you to edit files and make commits to the project.

1. Open a terminal/command line.
2. Navigate to the directory where you want to clone the repository using the `cd` (change directory) command. For example: `cd /path/to/your/directory/`.
3. Clone the repository using the `git clone` command followed by the URL of the repository. In this case, the command is `git clone http://github.com/CryptechTest/cryptech`.

After running the `git clone` command, you should have a local copy of the repository on your computer. You can confirm this by navigating to the directory in your file explorer or by typing `ls` (list files) in the terminal, which should now list a 'cryptech' directory.

## Step 3: Understand the Repository Structure

Based on the information on the GitHub page, the repository contains several important files and directories【7†source】:

- `media`: This directory likely contains media assets required for the game mode.
- `menu`: This directory may contain files related to the game mode's menu.
- `mods`: This directory likely contains the mods for the game mode.
- `.gitignore`: This file specifies files and directories that Git should ignore.
- `.gitmodules`: This file is used to store metadata about Git submodules.
- `LICENSE.md`: This file contains information about the license under which the code is released.
- `README.md`: This file typically contains information about the project and instructions for use.
- `export_remote_media`: The purpose of this file is unclear without more context, but it may be a script related to media assets.
- `game.conf`: This file likely contains configuration information for the game mode.
- `minetest.conf`: This file likely contains configuration information for Minetest.

The repository is written primarily in Lua (99.2%) with a small amount of Shell scripting (0.8%)【9†source】.

# Part 2: Using the Repository with a Minetest Server

Now that we have a basic understanding of Git and the structure of the repository, let's move on to using the repository with a Minetest server.

## Step 1: Copy the Game Mode to the Minetest Game Modes Directory

1. In your terminal/command line, navigate to the cloned repository directory (i.e., `cd /path/to/your/directory/cryptech`).
2. Copy the entire contents of the repository to your Minetest game modes directory. The exact location

of this directory will depend on your operating system and where Minetest is installed:

- On Linux, it is typically located in `~/.minetest/games/`.
- On Windows, it is typically located in `C:\Users\<YourUsername>\Documents\Minetest\games\`.
- On macOS, it is typically located in `~/Library/Application Support/minetest/games/`.

The command to copy the files will look something like this: `cp -r * /path/to/minetest/games/cryptech`. This command copies all files and directories (`-r` stands for recursive, meaning it includes subdirectories) from the current directory to the specified directory.

## Step 2: Configure the Minetest Server

1. If you have a `minetest.conf` file in the repository, you can replace your existing Minetest configuration file with this one. This file is typically located in the same directory as the Minetest executable. Be sure to make a backup of your existing `minetest.conf` file before replacing it.
2. If you don't have a `minetest.conf` file in the repository, or if it doesn't contain all the settings you need, you will need to edit your existing `minetest.conf` file to configure your Minetest server. The specific settings you need will depend on the game mode and your specific requirements.

## Step 3: Start the Minetest Server

You can now start your Minetest server with the new game mode. The exact command will depend on your operating system and where Minetest is installed, but it will look something like this: `minetest --worldname world --gameid cryptech`.

In this command, `worldname` is the name of the world you want to use with the new game mode, and `gameid` is the ID of the new game mode, which should be the same as the name of the directory you copied to the `games` directory.

# Conclusion

Congratulations, you have now set up a Minetest server with a new game mode from a GitHub repository! Remember, this is a basic guide and your actual implementation might require additional steps depending on the specifics of the game mode and your server setup. Always refer to the `README.md` file and any other documentation provided in the repository for more detailed instructions.

Also, remember that this guide assumes that you are comfortable using a terminal/command line interface. If you're not, there are many resources available online to help you learn, including the [official Git documentation](https://git-scm.com/doc) and tutorials on websites like [Codecademy](https://www.codecademy.com/learn/learn-the-command-line) and [Khan Academy](https://www.khanacademy.org/computing/computer-programming/programming). If you have any further questions, feel free to ask.

##Below is just for this DarkIlluminatus fork of the repo

This is an exciting project by the team who created the cryptechcraft minecraft server, which is one of the only servers to have advanced technologies in bedrock and java 1.19, alas, The Cryptechcraft server is shutting down. I understand how hard of a decision that must have been. But I also understand that the structure of this allows for a lot more customization and it's always seemed to me as if there was a very specific game they were going for, but Minecraft may not have been the best place for the job.

Anyway, I'll update this README as I learn more about how to set it up and flesh it out as I have time to. Just wanted a README so the repo based bot who reads this will understand what it's for.

Why am I forking? So I can eventually assist in adding AI powered characters, and that's why this readme is here so you can read it, we'll figure out how to make AI characters, and we can probably just use your built-in API interpreter, unless we've created a plugin for that purpose then we'll do it that way.

El Psy Congroo