Improve book, add diagrams #412

torkleyy · 2018-05-14T09:26:01Z

Fixes #327

Rendered

This change is

torkleyy · 2018-05-14T09:26:19Z

Ah yeah, I stole your idea @WaDelma 😄

torkleyy · 2018-05-14T09:27:34Z

When I made a presentation on ECS last year, I needed to explain the relationship and tables did work very well :)

Xaeroxe

Thanks!

WaDelma

I am not actually sure which part you stole from me :O
I added some edits that made it flow better for me, but be free to ignore any or all of the changes.
(Only really critical thing is that it says that diagram is below even though it's above :P)

WaDelma · 2018-05-14T16:33:27Z

book/src/01_intro.md


-In fact, an entity does not even own the components; it's just
+This is where ECS comes into play: Components are *associated* with entities; you just insert some component, whenever you like.


s/you just insert some component,/you can just insert components/

WaDelma · 2018-05-14T16:34:02Z

book/src/01_intro.md


-In fact, an entity does not even own the components; it's just
+This is where ECS comes into play: Components are *associated* with entities; you just insert some component, whenever you like.
+One entity may or may not have a certain component. You can see an `Entity` as an ID into component tables, as illustrated in the


s/component/component associated with it/

That's what I had initially, but then the sentence sounded a bit unnatural and I didn't want to repeat "associated" as it's already used in the line before.

I'm with @torkleyy here, the extra words don't add to comprehension.

WaDelma · 2018-05-14T16:35:18Z

book/src/01_intro.md

-In fact, an entity does not even own the components; it's just
+This is where ECS comes into play: Components are *associated* with entities; you just insert some component, whenever you like.
+One entity may or may not have a certain component. You can see an `Entity` as an ID into component tables, as illustrated in the
+diagram below. We could theoretically store all the components together with the entity, but that would be very inefficient;


s/below/above/

the one I'm referring to is below actually

Well then you are not referring to this one at all, right?

No, I don't think I am.

WaDelma · 2018-05-14T16:37:13Z

book/src/01_intro.md


-In fact, an entity does not even own the components; it's just
+This is where ECS comes into play: Components are *associated* with entities; you just insert some component, whenever you like.
+One entity may or may not have a certain component. You can see an `Entity` as an ID into component tables, as illustrated in the


Should there be clarification that metaphors tables are referring to database tables? So that a reader unfamiliar with databases wont get confused.

That was actaually the idea I borrowed from you. I thought simply talking about a table is clear enough.

WaDelma · 2018-05-14T16:42:33Z

book/src/01_intro.md

+Now we're only missing the last character in ECS - the "S" for `System`. Whereas components and entities are purely data,
+systems contain all the logic of your application. A system typically iterates over all entities that fulfill specific constraints,
+like "has both a force and a mass". Based on this data a system will execute code, e.g. produce a velocity out of the force and the mass.
+This is the additional advantage I wanted to point out with the `Player` / `Npc` example; in an ECS, you can simply add attributes and


s/is/has/
s/simply add attributes/easily add new attributes to existing entities/

Hmm these changes you suggest here, I don't really get how they improve the text. I think "is" fits better here because I want to regard specifically the advantage, not the way systems work.

As for the second change you propose, I chose "simply" to describe how plain the whole concept it is, yet it allows for such patterns. The difficulty of adding the attribute is not what I wanted to describe.

Personally I'd leave the "is"

I'd actually prefer a hybrid for the second request though

"simply add new attributes to entities"

WaDelma · 2018-05-14T16:46:01Z

book/src/01_intro.md

+systems contain all the logic of your application. A system typically iterates over all entities that fulfill specific constraints,
+like "has both a force and a mass". Based on this data a system will execute code, e.g. produce a velocity out of the force and the mass.
+This is the additional advantage I wanted to point out with the `Player` / `Npc` example; in an ECS, you can simply add attributes and
+that's also how you define your behaviour (this is called [data-driven] programming).


s/ and that's also how you define your/. Because the systems processing depends on the components associated with an entity this is also the way you define your entities/

Suggestion seems a bit wordy and doesn't add any new information imo.

WaDelma · 2018-05-14T16:47:07Z

book/src/01_intro.md

-the data-oriented way, I have to disappoint you; there is none.
-ECS libraries are best-suited for creating games; in fact, I've never
-heard of anybody using an ECS for something else.
+In case you were looking for a general-purpose library for doing it the data-oriented way, I have to disappoint you; there is none.


WaDelma · 2018-05-14T16:47:43Z

book/src/06_system_data.md

+
+## Specifying `SystemData`
+
+As mentioned earlier, `SystemData` is implemented for tuples of up to 26 elements. Should you ever need


WaDelma · 2018-05-14T16:48:32Z

book/src/06_system_data.md

+## Specifying `SystemData`
+
+As mentioned earlier, `SystemData` is implemented for tuples of up to 26 elements. Should you ever need
+more, you could even nest these tuples. However, at some point you can't keep track of all the elements anymore.


s/you can't/it becomes hard to/
s/ anymore//

WaDelma · 2018-05-14T16:49:53Z

book/src/06_system_data.md

+
+As mentioned earlier, `SystemData` is implemented for tuples of up to 26 elements. Should you ever need
+more, you could even nest these tuples. However, at some point you can't keep track of all the elements anymore.
+That's why you can also create your own `SystemData` bundle using a struct:


Btw what happens if you try to derive it for enum? I realised you could try to do this after reading this.

Doesn't work, which variant should it select?

Guessed as much :D

torkleyy · 2018-05-14T19:43:51Z

r? @WaDelma

WaDelma · 2018-05-14T20:42:57Z

book/src/01_intro.md

+systems contain all the logic of your application. A system typically iterates over all entities that fulfill specific constraints,
+like "has both a force and a mass". Based on this data a system will execute code, e.g. produce a velocity out of the force and the mass.
+This is the additional advantage I wanted to point out with the `Player` / `Npc` example; in an ECS, you can simply add new attributes
+to entities and that's also how you define your behaviour (this is called [data-driven] programming).


I was changing the your here, because for me it sounds like you are talking about coders behaviour, but it's fine.

torkleyy · 2018-05-14T20:46:23Z

Ah missed that, thanks!

bors r=Xaeroxe,WaDelma

412: Improve book, add diagrams r=Xaeroxe,WaDelma a=torkleyy Fixes #327 [Rendered](https://torkleyy.github.io/specs/)  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/slide-rs/specs/412)  Co-authored-by: torkleyy <torkleyy@gmail.com>

bors · 2018-05-14T21:20:29Z

Build succeeded

continuous-integration/travis-ci/push

Improve book, add diagrams

83979e6

torkleyy added the docs label May 14, 2018

torkleyy requested a review from WaDelma May 14, 2018 09:26

Rhuagh approved these changes May 14, 2018

View reviewed changes

torkleyy assigned WaDelma May 14, 2018

Xaeroxe approved these changes May 14, 2018

View reviewed changes

WaDelma requested changes May 14, 2018

View reviewed changes

Enhance wording in intro chapter

dbb7e2f

Address some more comments

9058daf

torkleyy requested a review from WaDelma May 14, 2018 19:55

WaDelma reviewed May 14, 2018

View reviewed changes

WaDelma approved these changes May 14, 2018

View reviewed changes

Change wording of data-driven explanation

4fd4164

bors bot merged commit 4fd4164 into amethyst:master May 14, 2018

torkleyy deleted the book branch May 15, 2018 04:55

torkleyy unassigned WaDelma Oct 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve book, add diagrams #412

Improve book, add diagrams #412

torkleyy commented May 14, 2018 •

edited

Loading

torkleyy commented May 14, 2018

torkleyy commented May 14, 2018 •

edited

Loading

Xaeroxe left a comment

WaDelma left a comment

WaDelma May 14, 2018

WaDelma May 14, 2018

torkleyy May 14, 2018

Xaeroxe May 14, 2018

WaDelma May 14, 2018

torkleyy May 14, 2018

WaDelma May 14, 2018

torkleyy May 14, 2018

WaDelma May 14, 2018

torkleyy May 14, 2018 •

edited

Loading

WaDelma May 14, 2018

torkleyy May 14, 2018

Xaeroxe May 14, 2018

WaDelma May 14, 2018

Xaeroxe May 14, 2018

WaDelma May 14, 2018

WaDelma May 14, 2018

WaDelma May 14, 2018

WaDelma May 14, 2018

torkleyy May 14, 2018

WaDelma May 14, 2018

torkleyy commented May 14, 2018

WaDelma May 14, 2018

torkleyy commented May 14, 2018

bors bot commented May 14, 2018


		In fact, an entity does not even own the components; it's just
		This is where ECS comes into play: Components are associated with entities; you just insert some component, whenever you like.


		## Specifying `SystemData`

		As mentioned earlier, `SystemData` is implemented for tuples of up to 26 elements. Should you ever need

Improve book, add diagrams #412

Improve book, add diagrams #412

Conversation

torkleyy commented May 14, 2018 • edited Loading

torkleyy commented May 14, 2018

torkleyy commented May 14, 2018 • edited Loading

Xaeroxe left a comment

Choose a reason for hiding this comment

WaDelma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

torkleyy May 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

torkleyy commented May 14, 2018

Choose a reason for hiding this comment

torkleyy commented May 14, 2018

bors bot commented May 14, 2018

Build succeeded

torkleyy commented May 14, 2018 •

edited

Loading

torkleyy commented May 14, 2018 •

edited

Loading

torkleyy May 14, 2018 •

edited

Loading