Skip to content
This repository has been archived by the owner on Mar 31, 2024. It is now read-only.

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
AngryPowman authored Jan 13, 2020
1 parent b070432 commit 0bd18d7
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Languages: [[English](./README.md)] [[简体中文](./docs/README.zh-cn.md)]

**AVGPlus** is an cross-platform engine that aims to AVG/ADV, Galgame, Audiobooks, etc. It provides a way to quickly build games for Windows, Linux and macOS, completely in JavaScript. You will get many simple APIs to build power game that had better performance from the engine.
**AVGPlus** is a cross-platform engine that aims to AVG/ADV, Galgame, Audiobooks, etc. It provides a way to quickly build games for Windows, Linux, and macOS, completely in JavaScript. You will get many simple APIs to build a power game that had a better performance from the engine.

## NOTICE: At an early stage of development

Expand All @@ -21,11 +21,11 @@ yarn
```

## Setup game project
During you can launch game, you should setup a project of game. The assets folder provide Scripts, Graphics, Audio resources for your game.
During you can launch the game, you should set up a project before. The assets folder provides Scripts, Graphics, Audio resources for your game.

### 1. Create game project folder
### 1. Create the game project folder
- Create a directory to your local disk, eg: `D:\GameProjects\hello-avg`.
- Create JSON file: `D:\GameProjects\hello-avg\game.json`, and write the basic game config:
- Create a JSON file: `D:\GameProjects\hello-avg\game.json`, and write the basic game config:
```json
{
"screen": {
Expand Down Expand Up @@ -56,7 +56,7 @@ text.show("Hello my first AVG ...");

* To see more story script API, please visit documentation http://docs.avg-engine.com

Finally your structure should be:
Finally, your structure should be:
```
D:\GameProjects\hello-avg
├── audio
Expand All @@ -78,11 +78,11 @@ Open `engine.json` file you can see:

This file is used for config & pointing to your game project root.

`game_assets_root`: The root folder of game project, it can be assign an URL or a path relative to local.
`engine_bundle_root`: The data root of engine package, recommended to keep the default.
`game_assets_root`: The root folder of the game project can be assigned a URL or a path relative to local.
`engine_bundle_root`: The data root of the engine package. (recommended to keep the default)

* To deploy your game to the user on the browser, you should provide an URL that points to your HTTP server.
* To deploy your game to desktop over PC, you should provide an URL that points to your local folder.
* To deploy your game to the user on the browser, you should provide a URL that points to your HTTP server.
* To deploy your game to desktop over PC, you should provide a URL that points to your local folder.

Example config for browser:
```json
Expand Down Expand Up @@ -110,7 +110,7 @@ yarn dev
This command is used for building engine bundles and keep the development in watching mode, you could open `dist` directory to see the outputs.

### 4. Run the game
Open another terminal session to launch game window:
Open another terminal session to launch the game window:

```shell
yarn game
Expand Down Expand Up @@ -141,6 +141,7 @@ If your game assets folder is addressable, you can see a game window launched an
## Buiding Problems

- `electron` & `node-sass` install failed or takes a long time

Due to `electron-prebuilt` and `node-sass` deploy on Github, it causing a problem of downloading. Especially in China, it will take a long time when you run `yarn`. To resolve the problem, you could use the following solution:

```
Expand All @@ -149,4 +150,4 @@ SASS_BINARY_SITE=https://npm.taobao.org/mirrors/node-sass/ yarn add node-sass -D
```

This changes the downloading mirror to `Taobao` in China.
But it should be noted this solution is **different** from changing the registry of `yarn`.
But it should be noted this solution is **different** from changing the registry of `yarn`.

0 comments on commit 0bd18d7

Please sign in to comment.