summaryrefslogtreecommitdiffhomepage
path: root/deploy_template/mygame/documentation/01-high-level.md
diff options
context:
space:
mode:
authorAmir Rajan <[email protected]>2019-09-06 15:33:10 -0500
committerAmir Rajan <[email protected]>2019-09-06 15:33:10 -0500
commit220c3f0ed4a323d5d7e354c7f1b7ff1e8b16c4e9 (patch)
treeea88e9c1425389a0fe4df8fb3d411a7c5fed1542 /deploy_template/mygame/documentation/01-high-level.md
parent9c2ce126dba8a4c3ada82e5f4bd6637b1fa92ab0 (diff)
downloaddragonruby-game-toolkit-contrib-220c3f0ed4a323d5d7e354c7f1b7ff1e8b16c4e9.tar.gz
dragonruby-game-toolkit-contrib-220c3f0ed4a323d5d7e354c7f1b7ff1e8b16c4e9.zip
Added deploy_template to contribe.
Diffstat (limited to 'deploy_template/mygame/documentation/01-high-level.md')
-rw-r--r--deploy_template/mygame/documentation/01-high-level.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/deploy_template/mygame/documentation/01-high-level.md b/deploy_template/mygame/documentation/01-high-level.md
new file mode 100644
index 0000000..7206d8d
--- /dev/null
+++ b/deploy_template/mygame/documentation/01-high-level.md
@@ -0,0 +1,31 @@
+# General Stuff
+
+- You have 1280x720 pixels to work with. The bottom left corner is 0, 0
+ with X increasing going right, and Y increasing going up.
+- The game is on a fixed 60 fps cycle (no delta time needed).
+- Come to the Discord if you need help: http://discord.dragonruby.org
+- Going through all the sample apps is a REALLY GOOD IDEA. Most sample apps
+ contain a recorded replay/demo. So just double click `watch-recording` to
+ see a full presentation of the sample.
+
+# Entry Point
+
+For all the examples in the other documentation files. It's assumed they
+are being placed into the follow code block:
+
+```
+# Entry point placed in main.rb
+def tick args
+ args.outputs.labels << [100, 100, 'hello world']
+end
+```
+
+# New to Ruby
+
+If you are a complete beginner and have never coded before:
+
+1. Run the 00_beginner_ruby_primer sample app and work through it.
+ Video walkthrough: https://s3.amazonaws.com/s3.dragonruby.org/dragonruby-gtk-primer.mp4
+2. Read all the code in the 00_intermediate_ruby_primer sample app.
+ Video walkthrough: https://s3.amazonaws.com/s3.dragonruby.org/dragonruby-gtk-intermediate.mp4
+3. There is also a free course you can sign up for at http://dragonruby.school