Skip to content

Commit 40ab7a8

Browse files
LusitoLusito
authored
Updated and new readmes and package keywords (#6)
1 parent 5050148 commit 40ab7a8

File tree

12 files changed

+197
-8
lines changed

12 files changed

+197
-8
lines changed

‎README.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,37 @@ This includes [TypeScript](https://github.com/Microsoft/TypeScript) ports of:
88

99
## Quick Start
1010

11-
Since this monorepo is not published on NPM yet, you can only run this locally.
11+
This monorepo is in it's early stage, so to get started, you'll have to taka a look at the testbed project for now.
12+
13+
## Monorepo Commands:
1214

1315
Most important commands to execute from the root folder (you need [yarn](https://yarnpkg.com/) installed):
1416
- `yarn` -> install dependencies
1517
- `yarn workspaces run build` -> build all projects
18+
- `yarn build:libs` -> build only the libraries
1619
- `yarn start` -> Run testbed locally
20+
- `yarn start:fresh` -> Run testbed locally after building all libraries freshly
1721
- `yarn run bench` -> Run the benchmark using node.js
1822
- `yarn run bench:web` -> Start a webserver for running the benchmarks using a browser,
1923
- `yarn run lint` -> Run linters, formatters, etc.
2024
- `yarn run lint:fix` -> Run linters, formatters, etc. and autofix if possible
25+
26+
## The @box2d Ecosystem
27+
28+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
29+
30+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
31+
32+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
33+
34+
Other packages included in the ecosystem:
35+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
36+
- Controllers: From the LiquidFun project
37+
- Particles: Also from the LiquidFun project
38+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
39+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
40+
41+
# Contributing
42+
43+
We're looking for contributors to make this the best place to start with box2d on the web.
44+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

‎packages/benchmark/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
A benchmark to compare various js/ts Box2D implementations.
44

5+
Try it here: https://lusito.github.io/box2d.ts/
6+
7+
**Fair Warning:** In theory this can be added as a dependency to other physics libraries in order to run benchmarks against local code. But this has not been tested yet.
8+
59
Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
610

711
## Example output using node.js v12.16.3
@@ -36,3 +40,23 @@ Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
3640
| box2d-html5 | 11.05 | 11 | 10 | 2.02 |
3741
| @flyover/box2d | 17.83 | 20 | 17 | 3.26 |
3842
| planck.js | 23.17 | 25 | 18 | 4.23 |
43+
44+
## The @box2d Ecosystem
45+
46+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
47+
48+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
49+
50+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
51+
52+
Other packages included in the ecosystem:
53+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
54+
- Controllers: From the LiquidFun project
55+
- Particles: Also from the LiquidFun project
56+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
57+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
58+
59+
# Contributing
60+
61+
We're looking for contributors to make this the best place to start with box2d on the web.
62+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

‎packages/benchmark/package.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22
"name": "@box2d/benchmark",
33
"version": "0.7.2",
44
"description": "A benchmark to compare various js/ts Box2D implementations",
5-
"homepage": "https://github.com/lusito/box2d.ts",
5+
"keywords": [
6+
"box2d",
7+
"performance",
8+
"benchmark",
9+
"game",
10+
"TypeScript"
11+
],
12+
"homepage": "https://lusito.github.io/box2d.ts/",
613
"bugs": {
714
"url": "https://github.com/lusito/box2d.ts/issues"
815
},

‎packages/controllers/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# @box2d/controllers
2+
3+
Controllers for @box2d/core
4+
5+
@box2d/controllers is a TypeScript port of Googles [LiquidFun](https://github.com/google/liquidfun) controllers.
6+
This is a fork of [box2d.ts](https://github.com/flyover/box2d.ts) from Isaac Burns (flyover) who did a huge job initially porting Box2D and [LiquidFun](https://github.com/google/liquidfun) to TypeScript.
7+
8+
## The @box2d Ecosystem
9+
10+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
11+
12+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
13+
14+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
15+
16+
Other packages included in the ecosystem:
17+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
18+
- Controllers: From the LiquidFun project
19+
- Particles: Also from the LiquidFun project
20+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
21+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
22+
23+
# Contributing
24+
25+
We're looking for contributors to make this the best place to start with box2d on the web.
26+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

‎packages/controllers/package.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22
"name": "@box2d/controllers",
33
"version": "0.7.2",
44
"description": "A TypeScript port of LiquidFuns controllers for @box2d/core",
5-
"homepage": "https://github.com/lusito/box2d.ts",
5+
"keywords": [
6+
"box2d",
7+
"liquidfun",
8+
"controller",
9+
"game",
10+
"TypeScript"
11+
],
12+
"homepage": "https://lusito.github.io/box2d.ts/",
613
"bugs": {
714
"url": "https://github.com/lusito/box2d.ts/issues"
815
},

‎packages/core/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# @box2d/core
2+
3+
Box2D is a 2D physics engine for games.
4+
5+
@box2d/core is a TypeScript port of Erin Cattos [Box2D](https://github.com/erincatto/box2d).
6+
This is a fork of [box2d.ts](https://github.com/flyover/box2d.ts) from Isaac Burns (flyover) who did a huge job initially porting Box2D and [LiquidFun](https://github.com/google/liquidfun) to TypeScript.
7+
8+
## The @box2d Ecosystem
9+
10+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
11+
12+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
13+
14+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
15+
16+
Other packages included in the ecosystem:
17+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
18+
- Controllers: From the LiquidFun project
19+
- Particles: Also from the LiquidFun project
20+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
21+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
22+
23+
# Contributing
24+
25+
We're looking for contributors to make this the best place to start with box2d on the web.
26+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

‎packages/core/package.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@
22
"name": "@box2d/core",
33
"version": "0.7.2",
44
"description": "A TypeScript port of Box2D",
5-
"homepage": "https://github.com/lusito/box2d.ts",
5+
"keywords": [
6+
"box2d",
7+
"physics",
8+
"2d",
9+
"collision",
10+
"game",
11+
"TypeScript"
12+
],
13+
"homepage": "https://lusito.github.io/box2d.ts/",
614
"bugs": {
715
"url": "https://github.com/lusito/box2d.ts/issues"
816
},

‎packages/lights/README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Box2DLights
1+
# @box2d/lights
22
[![screenshot](http://img.youtube.com/vi/lfT8ajGbzk0/0.jpg)](http://www.youtube.com/watch?v=lfT8ajGbzk0)
33

44
A [TypeScript](https://github.com/Microsoft/TypeScript) port of Kalle Hameleinen's Box2DLights.
@@ -25,3 +25,23 @@ This library offer easy way to add soft dynamic 2d lights to your physic based g
2525
## Usage
2626

2727
TODO (see the testbed for simple examples)
28+
29+
## The @box2d Ecosystem
30+
31+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
32+
33+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
34+
35+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
36+
37+
Other packages included in the ecosystem:
38+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
39+
- Controllers: From the LiquidFun project
40+
- Particles: Also from the LiquidFun project
41+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
42+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
43+
44+
# Contributing
45+
46+
We're looking for contributors to make this the best place to start with box2d on the web.
47+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

‎packages/lights/package.json‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@
22
"name": "@box2d/lights",
33
"version": "0.7.2",
44
"description": "A TypeScript port of Box2DLights",
5-
"homepage": "https://github.com/lusito/box2d.ts",
5+
"keywords": [
6+
"box2d",
7+
"libgdx",
8+
"lights",
9+
"lighting",
10+
"shadows",
11+
"game",
12+
"TypeScript"
13+
],
14+
"homepage": "https://lusito.github.io/box2d.ts/",
615
"bugs": {
716
"url": "https://github.com/lusito/box2d.ts/issues"
817
},

‎packages/particles/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# @box2d/particles
2+
3+
Particles for @box2d/core
4+
5+
@box2d/lights is a TypeScript port of Googles [LiquidFun](https://github.com/google/liquidfun) particles.
6+
This is a fork of [box2d.ts](https://github.com/flyover/box2d.ts) from Isaac Burns (flyover) who did a huge job initially porting Box2D and [LiquidFun](https://github.com/google/liquidfun) to TypeScript.
7+
8+
## The @box2d Ecosystem
9+
10+
@box2d is a full-blown ecosystem for box2d for the JavaScript/TypeScript world. It can be used both in the browser and in node.js
11+
12+
Check out demos and compare performance here: https://lusito.github.io/box2d.ts/
13+
14+
**Fair Warning:** The whole @box2d ecosystem is in an early stage, so it will probably change a lot before we release the first stable version (1.0.0).
15+
16+
Other packages included in the ecosystem:
17+
- Benchmark: Based on [bench2d](https://github.com/joelgwebber/bench2d) by joelgwebber
18+
- Controllers: From the LiquidFun project
19+
- Particles: Also from the LiquidFun project
20+
- Lights: [ported from LibGDX](https://github.com/libgdx/box2dlights)
21+
- Testbed: A set of demos, partially ports of the original projects, partially new ones.
22+
23+
# Contributing
24+
25+
We're looking for contributors to make this the best place to start with box2d on the web.
26+
Check out the project page for more information: https://github.com/Lusito/box2d.ts

0 commit comments

Comments
 (0)