Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dami2106 authored Mar 12, 2024
1 parent 3044cf6 commit 395d678
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
A Fabric mod for Minecraft to log discrete actions of the minecraft player.

## Usage
The mod works entirely within Minecraft. There are 2 commands needed to control the logger. Please see installation details below for instructions on installing a Fabric mod.
The mod works entirely within Minecraft. There are 2 commands needed to control the logger. Please see installation details below for instructions on installing a Fabric mod. Controls for discretely moving the player are also presented below

### Start Logging:
To start the logger, within Minecraft, run the following command:
Expand All @@ -19,6 +19,15 @@ To stop the logger, and save changes to the file, run the following from within
/actiontracker stop
```

### Discrete Movement Keys:
- **I** : Move forward by 1 block
- **O** : Jump Up and Move forward 1 block
- **U** : Jump Down and Move forward 1 block

These key bindings can be changed anytime in the Minecraft keybind menu:
<img width="974" alt="Screenshot 2024-03-12 at 17 18 01" src="https://github.com/dami2106/Minecraft-Action-Tracker/assets/102320150/6fe4453b-7a59-44d4-a5da-228b9f99807d">


## Installation
Download the latest .jar file from the GitHub. Once this .jar has been downloaded, please follow the following tutorial to install the mod to Minecraft.
Note the mod was built for Minecraft version 1.20.4 and has not been tested on any earlier or later versions.
Expand All @@ -32,23 +41,22 @@ Currently, the logger is able to detect:
- A block broken by the player, along with the coordinates and block type
- A block placed by the player, along with the coordinates and block type
- Players position when breaking or placing a block
- Players discrete movement, when moving in either North, East, South, or West. Logged on a per block movement scale.
- Players discrete movement, when moving in either North, East, South, or West.
- Player Jumping Up a block in a cardinal direction
- Player Jumping Down a block in a cardinal direction

### Example Output Format:
```
place,cobblestone,(-201.0, -60.0, 104.0),player,(-199.0, -60.0, 104.0)
move,old,(-200.0, -59.0, 104.0),new,(-199.0, -59.0, 104.0)
move,old,(-200.0, -59.0, 104.0),new,(-201.0, -59.0, 104.0)
place,cobblestone,(-201.0, -59.0, 104.0),player,(-200.0, -57.0, 104.0)
break,cobblestone,(-201.0, -60.0, 104.0),player,(-199.0, -60.0, 104.0)
move,east
break,east,cobblestone
move,west
place,east,cobblestone
jumpup,east
```

## Limitations
Currently, the mod is not able to track diagonal jumping.
We are only able to track plain movement of the player in standard NESW directions.

Additionally, only a single player can be logged at a time on a single-player world (multiplayer has not been tested).

Only 1 logger can be run at a time.
- Only a single player can be logged at a time on a single-player world (multiplayer has not been tested).
- Only 1 logger can be run at a time.
- Pickup up and Dropping items is not logged


0 comments on commit 395d678

Please sign in to comment.