Book #391

Defman · 2021-03-08T14:17:21Z

I have started some work on the book, I'm not sure what chapters we should have or in which order they should occur.
This PR will serve a way of commenting, writing, and discussing the layout and content of the book.

caelunshun

Looks good so far. We should wait to merge this until all the CLI tools and API features described here are implemented, though, or else people will get confused :)

caelunshun · 2021-03-09T04:04:20Z

docs/src/feather/getting-started.md

+
+### Add plugin
+```sh
+feather add <plugin-identifier> 


feather plugin add?

Thought about it, but what are you going to add which are not plugins?
Maybe add feather add as shortcut for feather plugin add <plugin-identifier>?

caelunshun · 2021-03-09T04:04:55Z

docs/src/feather/getting-started.md

+### Init
+To create a server in an exisiting directory
+```sh
+feather init [path]


We might want to rename the CLI tool to feather server, since in the long term we may implement a feather-client.

Hmm should a feather-client maybe have its own name, like quill has its own name?

docs/src/introduction.md

docs/src/quill/commands.md

docs/src/quill/ecs.md

caelunshun · 2021-03-09T04:07:55Z

docs/src/quill/ecs.md

+
+A `Component` is either a marker or a small amount of data.
+An `Entity` is a set of components.
+The `World` is a set of entities.


Ecs, not World (World contains blocks)

caelunshun · 2021-03-09T04:08:23Z

docs/src/quill/ecs.md

+let world = game.world;
+let entity = world.spawn((Player, Health { value: 10, max: 20}));
+let query = world.query::<(&Player, &mut Health)>();
+for (entity, (&player, &mut health) in query.iter() {


don't bind by reference here (it'll create copies)

So the iterator is going to return Ref<T> and Mut<T> or?

caelunshun · 2021-03-09T04:08:53Z

docs/src/quill/getting-started.md

+## Creating a new plugin
+To create a new plugin in an exisiting directory
+```sh
+cargo quill init [path]


maybe change to cargo quill new to mirror Cargo

Well I did describe the functionality of cargo init [path], init can create the project in the current directory, cargo new <path> cannot be used in the current directory (maybe cargo new . works?). Should I maybe not just add both?

caelunshun · 2021-03-09T04:09:13Z

docs/src/quill/getting-started.md

+
+## Recomendations
+We also recomend that you install the following
+### Rust analyzer


Also suggest IntelliJ Rust as an alternative.

I have not used IntelliJ Rust before, maybe you or someone else who have used it could write that part?

I've used it before, but in my experience the CLion version is better (still made by Jetbrains tho) since it has debugger support. I switched to vscode because the IntelliJ version was slower in my opinion.

ambeeeeee · 2021-03-09T16:26:04Z

docs/src/bundles.md

+# Bundles
+
+Bundles are a convenient way of adding the required components for a given entity.
+For instance, the Minecraft entity `Piglin` requires the marker `Piglin`, `Uuid`, `Position`, `Physics` and `Health`.


requires the marker Piglin, ...

The way this is written almost implies that all of those components are "markers." An easy way to fix this could be

For instance, the Minecraft entity Piglin requires these components: Uuid, Position, Physics, and the marker component, Piglin

ambeeeeee · 2021-03-09T16:26:51Z

docs/src/components.md

@@ -0,0 +1,17 @@
+# Components
+This page lists all components and 


Weird stop at and

ambeeeeee · 2021-03-09T16:28:09Z

docs/src/feather/getting-started.md

+# Plugins
+
+## Install
+### To install Feather, if you are running Unix,


Linux is not Unix! Typically people use *nix or just Linux

ambeeeeee · 2021-03-09T16:29:32Z

docs/src/introduction.md

+    - `common`
+    - `datapacks` should be moved to `libcraft`
+    - `ecs`
+    - `generated` is deprecated in favour of `libcraft`


I'm currently pulling this out of feather it might as well be removed from here

ambeeeeee · 2021-03-09T16:30:23Z

docs/src/quill/ecs.md

+# ECS
+ECS stands for Entity Component System and is an integral part of feather and quill.
+
+ECS is an alternative to Object Oriented Programming where you usally stores data in a object and then arrays of the object.


Maybe link to a more detailed and thorough explanation of ECS.

ambeeeeee · 2021-03-09T16:31:10Z

docs/src/quill/getting-started.md

+
+First you should install Rust, you can follow the guide below or visit [rustup.rs](https://rustup.rs/) directly.
+
+### To install Rust, if you are running Unix,


Linux is not unix.

He meant a Unix-like operating system.

dlee13 · 2021-03-09T17:13:05Z

docs/src/feather/getting-started.md

+
+## Commands
+### Init
+To create a server in an exisiting directory


typo: "existing"

Funny, it's from the man page of cargo 😂

dlee13 · 2021-03-09T17:13:33Z

docs/src/feather/getting-started.md

+Give a path as an argument to create in the given directory.
+
+### Start
+To start a server in an exisiting directory


typo: "existing"

dlee13 · 2021-03-09T17:15:14Z

docs/src/feather/getting-started.md

+```
+
+### Upgrade
+To upgrade plugins in an exsisting directory


typo: "existing"

dlee13 · 2021-03-09T17:21:07Z

docs/src/quill/getting-started.md

+```
+
+## Creating a new plugin
+To create a new plugin in an exisiting directory


one more "existing"

Defman · 2021-03-09T17:27:03Z

Feel free to submit pull request against my repo 😊

* Add particle page to docs * Fix typo

ambeeeeee · 2021-06-18T22:28:20Z

What's our plan for this?

Defman added 2 commits March 7, 2021 22:23

book

3a88db8

book

2a36959

Defman added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 8, 2021

Defman requested review from ambeeeeee, Schuwi and caelunshun March 8, 2021 14:17

Defman assigned oxkitsune and PauMAVA Mar 8, 2021

Defman changed the title ~~Started work on the book~~ Book Mar 8, 2021

Defman added 7 commits March 8, 2021 15:48

additions

5ed4cee

additions

4d8d4f6

getting started

351d0e0

slight changes

3dcade6

...

8474fd4

more book

c796eee

commands

d169664

caelunshun reviewed Mar 9, 2021

View reviewed changes

WIP

162c991

ambeeeeee suggested changes Mar 9, 2021

View reviewed changes

dlee13 reviewed Mar 9, 2021

View reviewed changes

docs/src/feather/getting-started.md

```

### Upgrade

To upgrade plugins in an exsisting directory

Copy link

Contributor

dlee13 Mar 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: "existing"

dlee13 reviewed Mar 9, 2021

View reviewed changes

oxkitsune and others added 3 commits March 13, 2021 11:30

Add particle page to docs (#1)

1d1cc5b

* Add particle page to docs * Fix typo

...

67d5386

...

a3ca47c

		@@ -0,0 +1,17 @@
		# Components
		This page lists all components and


		First you should install Rust, you can follow the guide below or visit [rustup.rs](https://rustup.rs/) directly.

		### To install Rust, if you are running Unix,

Book #391

Are you sure you want to change the base?

Book #391

Uh oh!

Conversation

Defman commented Mar 8, 2021

Uh oh!

caelunshun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Defman commented Mar 9, 2021

Uh oh!

ambeeeeee commented Jun 18, 2021

Uh oh!

Uh oh!