Skip to content

Commit 7c5c2fc

Browse files
authored
Create README.md
1 parent 275fb07 commit 7c5c2fc

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<p align="center">
2+
<img width="880" src="https://github.com/ashtonland/unity-ecs-snippets/assets/65512990/944e48ba-dcfb-4786-9a86-af2e937c5d3c" />
3+
</p>
4+
5+
<div align="center">
6+
<h3 align="center">Unity ECS/DOTS Snippets for VSCode</h3>
7+
<p align="center">
8+
Write Unity DOTS code faster with Systems, Components, & Jobs Snippets
9+
<br />
10+
<a href="https://github.com/ashtonland/unity-ecs-snippets"><strong>See on Github »</strong></a>
11+
<br />
12+
</p>
13+
</div>
14+
15+
## About
16+
Coding in Unity DOTS indroduces new boilerplate that needs to be remembered. From creating components, to shared components, to manged components referencing external resources—just to name a few—there is a lot of repetitive setup code when making each which becomes burdensome. However, this extension provides snippets for creating the boilerplate for most all scripts in Unity DOTS and will continue to expand. Instead of repeatedly typing the same lines 38 line setup for an ISystem with the additional start & stop callbacks, just type "dcsss" and start writting game code in seconds.
17+
18+
## ECS Snippets In Action
19+
<p align="center">
20+
<img width="800" src="https://github.com/ashtonland/unity-ecs-snippets/assets/65512990/664a39c7-59d1-425a-a48b-9f89a82b3f5d" />
21+
</p>
22+
23+
## Snippets
24+
| Command | Action |
25+
| :------------------- | :------------------- |
26+
| dcs | Create a Unity DOTS System with the ISystem interface |
27+
| dcsss | Create a Unity DOTS ISystem with onStartRunning & onStopRunning callbacks |
28+
| dcsb | Create a managed Unity DOTS System with the SystemBase class |
29+
| dcc | Create a Unity DOTS unmanaged component (recommended if using blittable types) |
30+
| dcmc | Create a Unity DOTS managed component (only if using NON-blittable types) |
31+
| dcmcer | Create a Unity DOTS managed component referencing an external resource |
32+
| dcsc | Create a Unity DOTS unmanaged shared component (for components used on many entities & with the same values) |
33+
| dcmsc | Create a Unity DOTS managed shared component (for shared components using non-blittable types) |
34+
| dcj | Create a Unity DOTS Job (no `using Unity.Entities` added with this command, for it is likely added to a System file & not standalone) |
35+
36+
### Naming Convention
37+
The commands above all begin with dc standing for "Dots Create ..." which means you can always just type dc and use the dropdown to find or read more about any command. For example, `dcsc` stands for Dots Create Shared Component.
38+
39+
## Supported Version of Unity DOTS
40+
- Unity DOTS 1.0.11 (The current production release as of July 2023)
41+
42+
## Contributing
43+
Feel free to open a pr on the github repository any time to create new snippets that you want to see! Also if you are not familiar with creating snippets, open up an issue requesting a new snippet 🤝
44+
45+
## Contributors
46+
<a href="https://github.com/ashtonland">
47+
<img alt="Ashton Dev" src="https://avatars.githubusercontent.com/u/65512990?v=4" width="80" />
48+
</a>
49+

0 commit comments

Comments
 (0)