Re: [SVN Info] Doom Builder 2, GZDoom Builder, Builder64
Posted: Thu Sep 04, 2014 2:18
I think the provided documentation maybe a bit - - - too verbose and not fully simplified. Some of the provided documentation is for those that want to create modules for Bootless Star or to modify the core, so not all of the documentation is created for general use in mind. What I am going to do is provide the steps in order to install and setup the program and the GZDoom Builder module (as it is actively developed at the time of this post). Whatever you learned from the overly complexed documentation that contains foreign jipperish, forget it about it for now.
To be sure there is NO confusion, I am going to start from the very beginning and work up -- and I'll try to keep it at a simplified language
<Note: I am going to start looking for video tutorial programs; walls of texts are no fun!>
Bootless Star
------------------------------------
====================================
------------------------------------
GZDoom Builder (Project Module or Module)
I hope these instructions helped, I have to stop now - I am about to sleep while I am keyboarding....
To be sure there is NO confusion, I am going to start from the very beginning and work up -- and I'll try to keep it at a simplified language
Bootless Star
- Installation
- Download the latest version of Bootless Star (core)
- CAUTION: The legacy is only available for those that need it specifically as the foundation and support with Ruby is completely different as opposed to the early beta builds. With that said, the Legacy version is outdated - unsupported and shouldn't be used for generalized use.
- Create a new folder anywhere you wish; this folder will later contain the Bootless Star program (in the next step)
- Do NOT create a folder in the Program Files or Program Files (x86)! Bootless Star is NOT designed to work in that environment!
As of Windows Vista, programs can NOT write or control within that environment without needing Administrative permissions.
- Do NOT create a folder in the Program Files or Program Files (x86)! Bootless Star is NOT designed to work in that environment!
- RECOMMENDED: Use 7Zip to extract the Bootless Star zip file to the newly created folder that was just created (the step above).
- Required Step for Windows 8 and later with Windows ZIP (via Windows Explorer Shell): After extracting the contents from the .zip file, you _MUST_ unblock the 'BootlessStar.bat' file. Doing this, Windows will allow the program to execute and run normally, failure to do this step - Windows will NOT allow the program to execute at all.
- Execute the BootlessStar.bat program and make sure it goes to the 'Main Menu' screen.
- Possible failures:
- Working Directory and Program Directory mismatch (or Hooking failure); when this error comes up, the program can not update the user's WD to match with the program's active directory. Please submit reports when this happens.
- Operating System Compatibility issue; the program detected that the host system is not using Windows 2000 or later (NOTE: Windows XP is the minimum requirement; running the program under Windows 2000 is not possible and will crash prematurely). This program is not compatible nor supported with WINE for those under Linux flavor.
- Possible failures:
Configuration - Directory Setup
Keeping this short; most of the settings can be ignored unless the user wishes to be adventurous or power user.- Go to the Settings (type: s key) menu from the Main Menu.
- Go to the Directory Setup option (type: 2 key)
[spoiler][/spoiler] - Look over what programs have not been detected by Bootless Star automatically.
- Bootless Star will state what was detected and what was not detected. For example: "Detected: [ False ]"
- True, Bootless Star was able to find this program or directory.
- False, Bootless Star was not able to find this program or directory.
- Select what was not detected and input the new desired location
The in the next few sections will provide what GZDoom Builder (Doom Builder 2) requires- When entering a new location path, use _exact_locations_ (or Absolute Paths). Meaning, do NOT use: ".\MyLocation\someProgram.exe", instead use: "C:\Some\Path\Here\MyLocation\someProgram.exe".
In addition, do _NOT_ in any circumstance use quotes. Bootless Star uses quotes in a entirely different purpose, when quotes are entered by the user the program will crash. If the path contains spaces and fancy characters, the program will automatically deal with those scenarios.
[spoiler][/spoiler]
- When entering a new location path, use _exact_locations_ (or Absolute Paths). Meaning, do NOT use: ".\MyLocation\someProgram.exe", instead use: "C:\Some\Path\Here\MyLocation\someProgram.exe".
- Most projects will require Microsoft Visual Studio; from the Directory Setup Menu, go to "[1] Microsoft Visual Studio Category"
[spoiler][/spoiler]
This will display what was detected and what was not detected. You shouldn't need to program this unless the user manually edited the system's global variable environment.
If incase you need to edit these, please pay close attention to the instructions as the locations are bit different.
Saving Configurations - Presets- From the main menu, go to: 'User Configuration' (type: 3 key)
[spoiler][/spoiler] - Save a new preset configuration file, by using 'Save Settings' (type: 2 key) and enter a new filename that you wish to use.
- It is nearly essentially to create a new a configuration file as modules will not allow the user to save their configurations without having one already from the Bootless Star program.
Installing Modules- From the Main Menu, go to 'Run Project Modules'
- To install a new module, type: i.
- A new window will appear on the desktop and Bootless Star will provide onscreen instructions.
To install a module, simply put the '.bat' file of the module (for example: GZDoomBuilder.bat) in this window.
[spoiler][/spoiler]
- A new window will appear on the desktop and Bootless Star will provide onscreen instructions.
- Close the window that should now contain the .bat you dropped into the folder.
- Press any key on the Bootless Star program to return to the Module screen.
- Make sure that the module you have just installed is visible on the list of available modules.
- Download the latest version of Bootless Star (core)
------------------------------------
====================================
------------------------------------
GZDoom Builder (Project Module or Module)
- Requirements
- Bootless Star version 1.5 or later
- Microsoft Visual Studio 2010 (Express or Commercial)
- Versions higher than 2010 are fine.
- TortoiseSVN
- It is required that the TortoiseSVN Commandline tools are installed!
- HTML Workshop
- (Optional) 7Zip
- (Optional) Inno Setup Builder
Execute the GZDoomBuilder.bat module- In Bootless Star's Main Menu, go to: 'Run Project Modules' (type: 1 key)
- From the 'Run Project Module' screen, type GZDoomBuilder
- If the module is not visible on the list, it must be first installed. Refer to Bootless Star 'Installing Modules', a few sections above from here.
Working Copy Target - Critical Step
Checking out the Doom Builder project directly from the SVN Database Repo- Go to any folder you wish to put the 'Doom Builder' local working copy. This can be on your desktop, your home folder, wherever you wish.
- NOTE: This is NOT the actual compiled program, but instead this contains the source code that makes this software possible to work.
- Checkout the Doombuilder project
- Using this address:
Code: Select all
https://svn.code.sf.net/p/doombuilder/code
- Using this address:
Configuring GZDoom Builder - Directory Setup
Keeping this short to only important topics, but do look around the settings and explorer what is available.
There is features that allows the Doombuilder Local Working Copy to be automatically updated before it is compiled and more, feel free to explore.- From the Main Menu in GZDoom Builder's module, go to Settings (Type: s key)
- Go to Directory Setup (type: 5 key)
- Go to 'Locate GZDoom Builder Directory' (type: 1 key)
- Enter the path that contains GZDoom Builder's solution file within the Doom Builder project local working copy.
- Within the working copy we just checked out from the step above, we need to tell this program where to find it.
- As of today, you can find the solution file in: doombuilder\branches\GZDoomBuilder
- [spoiler][/spoiler]
Update your preset- From the main menu, go to: 'Settings'
- Select ' Update Saved Profile', (type: u key)
- This will update your configuration with the latest changes. When this module is restarted, the configuration is automatically loaded during startup.
Compile! - FINALLY!!!- From the main menu, select the following:
- 1) Compile Core only
- Generates the GZDoom Builder core program, help documentation only. Plugins are excluded
- Generates the GZDoom Builder core program, help documentation, and default plugins.
- Generates the GZDoom Builder core program, help documentation, and all plugins (even unsupported ones).
- 1) Compile Core only
I hope these instructions helped, I have to stop now - I am about to sleep while I am keyboarding....