Skip to content

Commit 9b896f9

Browse files
committed
docs: 📝 Moved documentation to wiki
1 parent 48a318e commit 9b896f9

File tree

1 file changed

+2
-34
lines changed

1 file changed

+2
-34
lines changed

README.md

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,6 @@
11
# turtleEmulator-lib
22

33
This Libary is meant to Emulate the functions and behaviour of turtles in Minecraft.
4-
This is exclusively useful for testing.
4+
This is exclusively useful for testing with f.e. Busted
55

6-
### HOW TO USE
7-
8-
1. Clone this Repository within yours as a submodule
9-
2. require the ccPackage.lua of this repository
10-
11-
#### Setup
12-
13-
```lua
14-
local turtleEmulator = require("turtleEmulator")
15-
_G.turtle = turtleEmulator:createTurtle()
16-
```
17-
18-
19-
1. The TurtleEmulator needs to create a **turtle**, which will need to be used in globals.
20-
21-
That will allow your normal scripts to run normally, - using the emulator-turtle
22-
The turtle will start at **position (0,0,0) facing the x direction**
23-
24-
2. That was it. Your minimalistic setup is done.
25-
26-
The turtle will do all currently implemented operations as expected, such as
27-
```lua
28-
turtle.forward()
29-
turtle.getFuelLevel()
30-
turtle.dig()
31-
```
32-
33-
34-
----
35-
If you want further instructions about specific topics, follow these Docs:
36-
1. [Add items to the inventory](INVENTORY.md)
37-
2. [Create blocks within the world](BLOCKS.md)
38-
3. [Peripherals](PERIPHERALS.md)
6+
### [Documentation](https://github.com/mc-cc-scripts/turtleEmulator-lib/wiki)

0 commit comments

Comments
 (0)