User Tools

Site Tools


en:tutorials:creating_your_own_project

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:tutorials:creating_your_own_project [2019/03/04 04:50 (16 months ago)]
sausage [Creating your own Orx-based Project using 'init']
en:tutorials:creating_your_own_project [2020/06/22 22:26 (2 weeks ago)] (current)
iarwain Replaced nuklear with imgui for C++ extension as nuklear might become a C-compatible one in the future
Line 14: Line 14:
  
  
 +===== Interactive Mode =====
  
-===== Commandline Mode ===== +cd your way into the orx folder ​and type the ''​init''​ command ​without any parameters or double click the file from your desktop. You will enter interactive mode:
- +
-cd your way into the orx folder ​to try out the command. +
- +
-When typing ​the ''​init''​ command ​above, depending on what operating system you are on, you will receive the following output:+
  
 <​code>​ <​code>​
 c:​\Work\orx>​init c:​\Work\orx>​init
  
-== Not enough arguments: []+== No argument, switching to interactive mode 
 + * Project name (relative or full path)? 
 +</​code>​
  
-== Usagec:​\Work\orx\init.bat name+You only need to specify a full path or relative path in order to create and name a project. For example, you could enter a direct path like:
  
-  ​= name: Project namerelative or full path, required+''​C:​\Work\MyGame''​ 
 + 
 +Then the folder above will be created, and ''​MyGame''​ will be name of the Solution / Workspace / or Project. 
 + 
 +In the same way you could enter a relative path. For example on Linux or Mac: 
 + 
 +''​~/​Documents/​MyGame''​ 
 + 
 +After pressing Enter, choose one or more extensions (more on this in the next section). 
 + 
 + 
 +===== Getting Help ===== 
 + 
 +To see all commandline options: 
 + 
 +<​code>​ 
 +$ ./init --help 
 +== Usage: C:​\Work\orx\init.bat name [+/​-archive] [+/-c++] [+/-imgui] [+/​-nuklear] [+/​-scroll] 
 + 
 +  - name: Project name (relative or full path), required 
 +  - archive: orxArchive support (resources can be stored inside ZIP files)=[no],​ optional 
 +  - c++: Create a C++ project instead of C=[yes], optional 
 +  - imgui: Dear ImGui support (https://​github.com/​ocornut/​imgui)=[no],​ triggers [+c++], optional 
 +  - nuklear: Nuklear support (https://​github.com/​immediate-mode-ui/​nuklear)=[no],​ triggers [+c++], optional 
 +  - scroll: C++ convenience layer with config-object binding=[no],​ triggers [+c++], optional
 </​code>​ </​code>​
  
-You only need to specify a path in order to create ​and name a project. ​For example:+There are additional options ​to create a [[en:​tutorials:​creating_your_own_scroll_project_using_init|Scroll-based]] or [[en:​tutorials:​imgui|ImGui-based ​project]] (or both). 
 + 
 + 
 +===== Screen Output ===== 
 + 
 +You will see the following as the various projects and solutions are created for many IDEs:
  
 <​code>​ <​code>​
Line 91: Line 119:
 </​code>​ </​code>​
  
- 
- 
-===== Interactive mode =====  
- 
-For those who prefer not to use the commandline,​ init can be clicked directly from the Windows Explorer (for windows), Finder on Mac, or for Linux... could be anything really. 
- 
-When you click on ''​init.bat''​ or ''​init.sh'',​ you will be asked for a path. If you enter something like: 
- 
-''​c:​\work\MyGame''​ 
- 
-Then the folder above will be created, and ''​MyGame''​ will be name of the Solution / Workspace / or Project. 
- 
-In the same way for Linux or Mac if you could enter something like: 
- 
-''​~/​Documents/​MyGame''​ 
  
  
Line 128: Line 141:
  
 That's about it. A lot of work has gone into making this as bullet proof as possible, so you should have no trouble spinning up new projects whenever you need one. That's about it. A lot of work has gone into making this as bullet proof as possible, so you should have no trouble spinning up new projects whenever you need one.
 +
 +
 +===== Extensions =====
 +
 +You can also create [[en:​tutorials:​creating_your_own_scroll_project_using_init|orx/​Scroll-based projects]] for an object oriented way of using Orx with c++.
 +
 +For making Orx applications with a UI, like applications and editors, you can create [[en:​tutorials:​imgui|Dear ImGui-based projects]].
 +
 +Or a combination of both.
 +
 +==== C or C++ projects ====
 +This extension allows you to specify if you want a C or C++ based project. However some extensions like ''​scroll''​ or ''​imgui''​ require ''​+c++''​ and are incompatible. For example, this will give an error:
 +
 +<​code>​
 +./init.bat /​temp/​projecttest +scroll -c++
 +[ 8:10:49 ] == [ scroll ] triggers [ +c++ ]
 +== Aborting, the following extensions have been both required and prohibited: [ c++ ]
 +</​code>​
 +
  
 ====== Troubleshooting ====== ====== Troubleshooting ======
en/tutorials/creating_your_own_project.1551675057.txt.gz · Last modified: 2019/03/04 08:50 (16 months ago) (external edit)