hytopia 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
@@ -1,19 +1,5 @@
|
|
1
1
|
# HYTOPIA SDK
|
2
2
|
|
3
|
-
## Quickstart
|
4
|
-
|
5
|
-
1. Install the SDK in a new or existing [Node.js](https://nodejs.org/), [Bun (recommended)](https://bun.sh/) or [Deno](https://deno.com/) project.
|
6
|
-
```bash
|
7
|
-
npm install hytopia
|
8
|
-
```
|
9
|
-
|
10
|
-
2. Run a local HYTOPIA server using an example game included in the SDK. The following command will start the Zombie Arena example game on port 8080.
|
11
|
-
```bash
|
12
|
-
npx hytopia examples/zombie-arena
|
13
|
-
```
|
14
|
-
|
15
|
-
3. Visit https://play.hytopia.com - when prompted, enter the local server your game is running on, which is `http://localhost:8080`.
|
16
|
-
|
17
3
|
## What is HYTOPIA?
|
18
4
|
|
19
5
|
![HYTOPIA Banner](./docs/assets/banner.png)
|
@@ -36,6 +22,20 @@ Available as a simple NPM package, this SDK provides everything you need to get
|
|
36
22
|
|
37
23
|
With these resources, you can quickly build and share immersive, voxel-style multiplayer games on HYTOPIA.
|
38
24
|
|
25
|
+
## Quickstart
|
26
|
+
|
27
|
+
1. Install the SDK in a new or existing [Node.js](https://nodejs.org/), [Bun (recommended)](https://bun.sh/) or [Deno](https://deno.com/) project.
|
28
|
+
```bash
|
29
|
+
npm install hytopia
|
30
|
+
```
|
31
|
+
|
32
|
+
2. Run a local HYTOPIA server using an example game included in the SDK. The following command will start the Zombie Arena example game on port 8080.
|
33
|
+
```bash
|
34
|
+
npx hytopia examples/zombie-arena
|
35
|
+
```
|
36
|
+
|
37
|
+
3. Visit https://play.hytopia.com - when prompted, enter the local server your game is running on, which is `http://localhost:8080`.
|
38
|
+
|
39
39
|
## Architecture & Motivation
|
40
40
|
|
41
41
|
HYTOPIA gives developers full control to create any game imaginable in a voxel-like style. The underlying architecture handles low-level tasks like networking, prediction, entity lifecycle, physics and more, so you can focus on building and deploying games quickly.
|
package/package.json
CHANGED