Skip to content

Commit 048854d

Browse files
committed
Update README.md
1 parent cbb3367 commit 048854d

File tree

2 files changed

+30
-41
lines changed

2 files changed

+30
-41
lines changed

README.md

Lines changed: 29 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# AgentScript
22

3-
AgentScript is a minimalist Agent Based modeling system based on [NetLogo](https://ccl.northwestern.edu/netlogo/) semantics. We have an [IDE here](https://code.agentscript.org/ide/index.html).
3+
AgentScript is a minimalist Agent Based modeling system based on [NetLogo](https://ccl.northwestern.edu/netlogo/) semantics. We also have an [IDE](https://code.agentscript.org/ide/index.html), especially useful for getting started.
44

55
It has a Model/View/Control (MVC) architecture which cleanly separates the three components.
66

77
- **Model**: Provides NetLogo-like semantics for Patches, Turtles and Links. It has no colors, shapes, sizes etc for viewing the model.
88

9-
- **View**: Use the Model properties to create a view. There can be many Views. We provide a [2D Canvas](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D) view and a [Three.js](https://threejs.org/) 2.5D and 3D views. There is also GIS support via a [gis module](https://github.com/backspaces/agentscript/blob/master/src/gis.js), a [geojson module](https://github.com/backspaces/agentscript/blob/master/src/geojson.js), as well as [Leaflet](https://leafletjs.com/) and [MapLibre](https://github.com/maplibre/maplibre-gl-js#readme/) based demos. Plot views are also available.
9+
- **View**: Use the Model properties to create a view. There can be many Views. We provide a [2D Canvas](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D) view and a [Three.js](https://threejs.org/) 2.5D and 3D views. There is also GIS support via a [gis module](https://github.com/backspaces/agentscript/blob/master/src/gis.js), a [geojson module](https://github.com/backspaces/agentscript/blob/master/src/geojson.js), as well as [Leaflet](https://leafletjs.com/) and [MapLibre](https://github.com/maplibre/maplibre-gl-js#readme/) based maps. Plot views are also available.
1010

1111
- **Controls**: We use [src/GUI.js](https://code.agentscript.org/src/GUI.js) via [dat.gui](https://github.com/dataarts/dat.gui) for a menu UI, a [Mouse module](https://github.com/backspaces/agentscript/blob/master/src/Mouse.js) for selecting Model objects (Patches, Turtles and Links), an [Animator](https://github.com/backspaces/agentscript/blob/master/src/Animator.js) for fine control over the Model/Draw steps. We also have [Keyboard](https://github.com/backspaces/agentscript/blob/master/src/Keyboard.js) and [Buttons](https://github.com/backspaces/agentscript/blob/master/src/Buttons.js) controls.
1212

@@ -18,47 +18,11 @@ This allows direct access to individual modules which will automatically load on
1818

1919
Example: to import Class Model for building your own model, use:
2020

21-
> import Model from './path/to/agentscript/src/Model.js'
22-
23-
.. where path/to/agentscript is a local file system path or a url to a server:
24-
25-
- local: [./src/Model.js](https://raw.githubusercontent.com/backspaces/agentscript/master/src/Model.js)
26-
- code.agentscript.org: [https://code.agentscript.org/src/Model.js](https://code.agentscript.org/src/Model.js)
27-
- unpkg.com: [https://unpkg.com/agentscript/src/Model.js](https://unpkg.com/agentscript/src/Model.js)
28-
- skypack.dev: [https://cdn.skypack.dev/agentscript/src/Model.js](https://cdn.skypack.dev/agentscript/src/Model.js)
29-
30-
There are bundles as well of all the agentscript modules as a single file from the usual NPM-based CDNs:
31-
32-
- unpkg.com: [https://unpkg.com/agentscript/dist/agentscript.js](https://unpkg.com/agentscript/dist/agentscript.js)
33-
34-
To create your own local agentscript files:
35-
36-
- Go to: https://github.com/backspaces/agentscript
37-
- Click on the large green `Code` button
38-
- Click on `Download ZIP`. The creates the file agentscript-master.zip
39-
- Unzip this. Creates agentscript-master/
40-
- Rename/Move to where you want it.
41-
42-
## Files
43-
44-
Our directory layout is:
45-
46-
### The core agentscript directories:
47-
48-
- [models/](https://github.com/backspaces/agentscript/tree/master/models): simple sample/demo models. All are es6 modules used in onepagers below
49-
- [src/](https://github.com/backspaces/agentscript/tree/master/src): all the agentscript source code. All are es6 modules
50-
- [docs/](https://code.agentscript.org/docs/) Documentation for all the individual modules used by the programmer.
51-
52-
### Developer directories:
53-
54-
- [bin/](https://github.com/backspaces/agentscript/tree/master/bin): workflow scripts
55-
- [dist/](https://unpkg.com/browse/agentscript/dist/): the umd and esm bundles with their min.js versions and src/.
56-
- [test/](https://github.com/backspaces/agentscript/tree/master/test): testing using Deno with it's browser environment running all models/ using its test feature to report errors.
57-
- [config/](https://github.com/backspaces/agentscript/tree/master/config): tools for creating "bundles".<br>
21+
> import Model from 'https://code.agentscript.org/src/Model.js'
5822
5923
## Run demos
6024

61-
The models directory contains the individual Models JavaScript files. I.e. HelloModel.js exports the HelloModel etc. It is the only demo directory with .js files, the rest are "onepagers" .html files.
25+
The models directory contains the individual Models JavaScript files.
6226

6327
[models](https://code.agentscript.org/models/)
6428

@@ -105,6 +69,31 @@ and
10569
10670
An experimental distributed framework for running models in one page while listening & getting results in another. We call these Model Transforms. They currently show their results in the browser console. -->
10771

72+
## Developer
73+
74+
To create your own local agentscript files:
75+
76+
- Go to: https://github.com/backspaces/agentscript
77+
- Click on the large green `Code` button
78+
- Click on `Download ZIP`. The creates the file agentscript-master.zip
79+
- Unzip this. Creates agentscript-master/
80+
- Rename/Move to where you want it.
81+
82+
### The core agentscript directories:
83+
84+
The models directory contains the individual Models JavaScript files. I.e. HelloModel.js exports the HelloModel etc. It is the only demo directory with .js files, the rest are .html files.
85+
86+
- [models/](https://github.com/backspaces/agentscript/tree/master/models): simple sample/demo models. All are es6 modules used in onepagers below
87+
- [src/](https://github.com/backspaces/agentscript/tree/master/src): all the agentscript source code. All are es6 modules
88+
- [docs/](https://code.agentscript.org/docs/) Documentation for all the individual modules used by the programmer.
89+
90+
### Developer directories:
91+
92+
- [bin/](https://github.com/backspaces/agentscript/tree/master/bin): workflow scripts
93+
- [dist/](https://unpkg.com/browse/agentscript/dist/): the umd and esm bundles with their min.js versions and src/.
94+
- [test/](https://github.com/backspaces/agentscript/tree/master/test): testing using Deno with it's browser environment running all models/ using its test feature to report errors.
95+
- [config/](https://github.com/backspaces/agentscript/tree/master/config): tools for creating "bundles".<br>
96+
10897
## Developer Information
10998

11099
Most users need not worry about this, you can access all the AgentScript code as described above using local files or servers. This is for those wishing to build the AgentScript system itself.

0 commit comments

Comments
 (0)