Spaces:
Runtime error
Runtime error
docs: updated getting started
Browse files
README.md
CHANGED
@@ -4,7 +4,21 @@
|
|
4 |
|
5 |
[![Discord](https://img.shields.io/discord/1091306623819059300?color=7289da&label=Discord&logo=discord&logoColor=fff&style=for-the-badge)](https://discord.com/invite/m3TBB9XEkb)
|
6 |
|
7 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
8 |
|
9 |
Discover a web-based user interface designed for prompt-driven development, enabling users to create
|
10 |
a wide array of digital art including games, visual effects, fractal art, and flow fields. This
|
@@ -27,7 +41,16 @@ imagination with the Prompt-Driven WebUI for creative 2D game development.
|
|
27 |
|
28 |
## Getting Started
|
29 |
|
30 |
-
To get started with the Prompt-Driven WebUI for 2D Game Development,
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
|
32 |
1. Clone the repository to your local machine.
|
33 |
2. Copy the `.env.local.example` file to a new file named `.env.local` and add your `OPENAI_API_KEY`
|
@@ -35,5 +58,3 @@ To get started with the Prompt-Driven WebUI for 2D Game Development, follow thes
|
|
35 |
3. Install the required dependencies using `npm install`.
|
36 |
4. Run the development server with `npm run dev` to access the WebUI.
|
37 |
5. Begin creating your own 2D games in JavaScript
|
38 |
-
|
39 |
-
Happy creating!
|
|
|
4 |
|
5 |
[![Discord](https://img.shields.io/discord/1091306623819059300?color=7289da&label=Discord&logo=discord&logoColor=fff&style=for-the-badge)](https://discord.com/invite/m3TBB9XEkb)
|
6 |
|
7 |
+
---
|
8 |
+
|
9 |
+
<!-- toc -->
|
10 |
+
|
11 |
+
- [Prompt-Driven WebUI for 2D Game Development](#prompt-driven-webui-for-2d-game-development)
|
12 |
+
* [Features](#features)
|
13 |
+
* [Getting Started](#getting-started)
|
14 |
+
+ [On 🤗 Spaces](#on-%F0%9F%A4%97-spaces)
|
15 |
+
+ [On your computer](#on-your-computer)
|
16 |
+
|
17 |
+
<!-- tocstop -->
|
18 |
+
|
19 |
+
---
|
20 |
+
|
21 |
+
# Prompt-Driven WebUI for 2D Game Development
|
22 |
|
23 |
Discover a web-based user interface designed for prompt-driven development, enabling users to create
|
24 |
a wide array of digital art including games, visual effects, fractal art, and flow fields. This
|
|
|
41 |
|
42 |
## Getting Started
|
43 |
|
44 |
+
To get started with the Prompt-Driven WebUI for 2D Game Development, you have two choices: Use the
|
45 |
+
hosted demo on 🤗 Spaces or run it directly on your computer.
|
46 |
+
|
47 |
+
### On 🤗 Spaces
|
48 |
+
|
49 |
+
The **2D GameCreator-GPT** is hosted on Hugging Face Spaces.
|
50 |
+
|
51 |
+
### On your computer
|
52 |
+
|
53 |
+
If you want to run the UI locally, please follow these steps!
|
54 |
|
55 |
1. Clone the repository to your local machine.
|
56 |
2. Copy the `.env.local.example` file to a new file named `.env.local` and add your `OPENAI_API_KEY`
|
|
|
58 |
3. Install the required dependencies using `npm install`.
|
59 |
4. Run the development server with `npm run dev` to access the WebUI.
|
60 |
5. Begin creating your own 2D games in JavaScript
|
|
|
|