Setting up a Workspace: Difference between revisions

From The DarkMod Wiki
Jump to navigationJump to search
Incomplete - going for a 10min walk, just saving to be safe.
 
No edit summary
Line 1: Line 1:
=Intro=
=Intro=
Most times when a new mapper or contributer starts working with TDM they fail to set up an initial "good" workspace, as to avoid cluttering with either TDM or doom3 itself. In this I will try to very briefly explain how to best go about this.
Most times when a new mapper or contributer starts working with TDM they fail to set up an initial "good" workspace, as to avoid cluttering with either TDM or doom3 itself. In this I will try to very briefly explain how to best go about this. This guide is aimed at people who know the basics of DarkRadiant and are average Windows users(you must know how to change a file extension)
 
Advantages of setting it up the first time:
* Very easy to package your fm up if you're going to release it
* Easy to keep test versions away from real work
* Easier to manage
* Easy to backup your work or submit it to TDM if you're a contributer!
* You'll be able to use pointfiles for fixing leaks before going to the forum and asking "DR says it cant find the pointfile!"!
 


First of all we're going to make a map, even if you're going to be working on models or textures you 'will' want a testmap that's well set up.
First of all we're going to make a map, even if you're going to be working on models or textures you 'will' want a testmap that's well set up.
Line 7: Line 15:
* Go into your doom3 folder (i.e C:\games\doom3\)
* Go into your doom3 folder (i.e C:\games\doom3\)
* Create a new folder, give it a simple name which you will remember and keep the name lowercase for sake of doom3 being happy (e.g : testmap)
* Create a new folder, give it a simple name which you will remember and keep the name lowercase for sake of doom3 being happy (e.g : testmap)
* Create a folder called "maps", you should place all of your maps that you've made in here (i.e soundtest.map). NOT in _C:\games\doom3\darkmod\maps\_
* Create a folder called "maps", you should place all of your maps that you've made in here (i.e soundtest.map). NOT in `C:\games\doom3\darkmod\maps\`
 


The same goes for textures, sounds, skins and anything else. You should not have to mess around with anything in the C:\games\doom3\darkmod\ folder.
The same goes for textures, sounds, skins and anything else. You should not have to mess around with anything in the C:\games\doom3\darkmod\ folder.
Line 13: Line 22:


=Getting your workspace into DR and TDM=
=Getting your workspace into DR and TDM=
In order to get your materials, sounds and misc other things into Dark Radiant and test them ingame you need to inform them about your fm.
In order to get your materials, sounds and misc other things into DarkRadiant and test them ingame you need to inform them about your fm.


===Dark Radiant===
===DarkRadiant===
* In the menu bar go to : file -> preferences -> select game
* In the menu bar go to : file -> preferences -> select game
* You will now see a dialogue box about where doom3 and such is installed.
* You will now see a dialogue box about where doom3 and such is installed.
Line 22: Line 31:
** Mod : darkmod
** Mod : darkmod
** Mod Base : testmap
** Mod Base : testmap


Once this is set up, DR will import your sounds, textures and whatever else on loading.
Once this is set up, DR will import your sounds, textures and whatever else on loading.
Line 27: Line 37:
===The Dark Mod===
===The Dark Mod===
There are three methods
There are three methods
====The Good====
====The Good(slow and not that useful)====
Convert your little testmap folder into a micro-fm by creating the following files in the base testmap folder: file name and in the block some example content.
Convert your little testmap folder into a micro-fm by creating the following files in the base testmap folder: file name and in the block some example content.


darkmod.txt :
darkmod.txt :
  Title:My little test map
  Title: My little test map
  Description: I test things here
  Description: I test things here
  Author: HEY MAAA! THE MEATLOAF!
  Author: HEY MAAA! THE MEATLOAF!
Line 38: Line 48:
startingmap.txt :
startingmap.txt :
  soundtest
  soundtest


When you start TDM, you will still have to 'dmap soundtest' or what have you, using the console(ctrl+alt+`) should you need to, but this is the "safest" method to test. It's however quite slow and not really useful for most people.
When you start TDM, you will still have to 'dmap soundtest' or what have you, using the console(ctrl+alt+`) should you need to, but this is the "safest" method to test. It's however quite slow and not really useful for most people.


====The Bad(but actually quite good)====
====The Bad(but actually quite good, fast)====
* Create a shortcut to doom3.exe (C:\games\doom3\DOOM3.exe)
* Create a shortcut to doom3.exe (C:\games\doom3\DOOM3.exe)
* Right click the shortcut -> properties
* Right click the shortcut -> properties
Line 48: Line 59:
** On some versions of windows you might need to put quotes in: "C:\games\doom3\DOOM3.exe"
** On some versions of windows you might need to put quotes in: "C:\games\doom3\DOOM3.exe"
* Move the shortcut to someplace more accessible
* Move the shortcut to someplace more accessible


Using the console once the game launches you will be able to 'dmap soundtest', 'map soundtest' or whatever's needed.
Using the console once the game launches you will be able to 'dmap soundtest', 'map soundtest' or whatever's needed.
Line 56: Line 68:
On next starting TDM you will be able to open the console and "dmap soundtest" or whatever you need. Once you're done with playing in your testmap you just revert the change in the text file. This also allows quick and easy changing between fm's without too much effort.
On next starting TDM you will be able to open the console and "dmap soundtest" or whatever you need. Once you're done with playing in your testmap you just revert the change in the text file. This also allows quick and easy changing between fm's without too much effort.


=An Example : Adding a texture=


If you're set up and on your road to fm making glory now, please take the time to test how it all fits together by doing something like this :
=An Example : Adding a custom texture to your map=


See that sweet damn smiley face on the right? Yeah you do. Now lets get it in game
[[Image:Smiley.jpg|256px|right|test texture]]
In your testmap folder
If you're set up and on your road to fm making glory now, please take the time to test how it all fits together by doing something like this.
Right click it -> Save image as ->
I assume you know how to use DarkRadiant and have made a very simple test map called texturetest in your C:\games\doom3\testmap\maps\ folder (the file would be texturetest.map)
Please take note that we will be using a jpeg file, ''textures should never use jpegs'' for a number of reasons, however for the ease of demonstration we will in this case.


textures/mymaterials/smileyface
 
* In your testmap folder create a new subfolder named "textures" and in there we will further organize it by making another subdirectory "smiley". Once created enter the "smiley folder"
* Are you now in something like C:\games\doom3\testmap\textures\smiley ? you should be.
* Right click the smiley face -> Save image as -> Browse to the smiley folder -> save as "smiley.jpg"
* Is there now a smiley.jpg in the folder? if it's named incorrectly just rename it. If it's not there... try again.
* Go back to your main testmap folder (C:\games\doom3\testmap\)
* Create a new folder named "materials", then enter it
* Create a new text file (right click in folder -> new -> text document) and rename it to something.mtr
* Open something.mtr in your text editor of choice (eg Notepad, not Word or anything officey)
* Paste the following block of text into the file and save it :
 
textures/mymaterials/smileyface
  {
  {
     wood
     wood
     diffusemap textures/smileyface/yellowsmileyface
     diffusemap textures/smiley/yellowsmileyface
     // TDM Ambient Method Related
     // TDM Ambient Method Related
     {
     {
         blend  add
         blend  add
         map    textures/stained/gothic_frame_dark1_alphatest
         map    textures/smiley/yellowsmileyface
         red    global2
         red    global2
         green  global3
         green  global3
Line 77: Line 100:
     }
     }
  }
  }
* If you don't have DarkRadiant running, start it. If you do already have it started fo to file -> Reload Shaders.
* In the material browser find your smiley face (click the textures folder once then press shift and the right arrow key to expand all folders. Once they are expanded click on a random material or folder there and just start typing "smiley"... that should do the trick!)
If you apply it to a brush in your test map then save it, you should be able to launch TDM using one of the methods shown in this document and after "dmap texturetest" "map texturetest" you should be able to see it ingame!

Revision as of 04:59, 11 August 2010

Intro

Most times when a new mapper or contributer starts working with TDM they fail to set up an initial "good" workspace, as to avoid cluttering with either TDM or doom3 itself. In this I will try to very briefly explain how to best go about this. This guide is aimed at people who know the basics of DarkRadiant and are average Windows users(you must know how to change a file extension)

Advantages of setting it up the first time:

  • Very easy to package your fm up if you're going to release it
  • Easy to keep test versions away from real work
  • Easier to manage
  • Easy to backup your work or submit it to TDM if you're a contributer!
  • You'll be able to use pointfiles for fixing leaks before going to the forum and asking "DR says it cant find the pointfile!"!


First of all we're going to make a map, even if you're going to be working on models or textures you 'will' want a testmap that's well set up.

Creation and layout (contains the examples!!)

  • Go into your doom3 folder (i.e C:\games\doom3\)
  • Create a new folder, give it a simple name which you will remember and keep the name lowercase for sake of doom3 being happy (e.g : testmap)
  • Create a folder called "maps", you should place all of your maps that you've made in here (i.e soundtest.map). NOT in `C:\games\doom3\darkmod\maps\`


The same goes for textures, sounds, skins and anything else. You should not have to mess around with anything in the C:\games\doom3\darkmod\ folder. If you were adding a skin to your testmap it would be placed in C:\games\doom3\testmap\skins\ etc. Later on we will look at getting a texture into your testmap/fm.

Getting your workspace into DR and TDM

In order to get your materials, sounds and misc other things into DarkRadiant and test them ingame you need to inform them about your fm.

DarkRadiant

  • In the menu bar go to : file -> preferences -> select game
  • You will now see a dialogue box about where doom3 and such is installed.
  • Make sure the settings are as follows (using our example of C:\games\doom3\testmap)
    • Engine Path : D:/games/doom3/ Note the slashes
    • Mod : darkmod
    • Mod Base : testmap


Once this is set up, DR will import your sounds, textures and whatever else on loading.

The Dark Mod

There are three methods

The Good(slow and not that useful)

Convert your little testmap folder into a micro-fm by creating the following files in the base testmap folder: file name and in the block some example content.

darkmod.txt :

Title: My little test map
Description: I test things here
Author: HEY MAAA! THE MEATLOAF!
Required TDM Version: Whatever

startingmap.txt :

soundtest


When you start TDM, you will still have to 'dmap soundtest' or what have you, using the console(ctrl+alt+`) should you need to, but this is the "safest" method to test. It's however quite slow and not really useful for most people.

The Bad(but actually quite good, fast)

  • Create a shortcut to doom3.exe (C:\games\doom3\DOOM3.exe)
  • Right click the shortcut -> properties
  • Change the "target" to something like :
    • C:\games\doom3\DOOM3.exe +set fs_game darkmod +set fs_game_base testmap
    • On some versions of windows you might need to put quotes in: "C:\games\doom3\DOOM3.exe"
  • Move the shortcut to someplace more accessible


Using the console once the game launches you will be able to 'dmap soundtest', 'map soundtest' or whatever's needed.

The ugly(I prefer personally)

  • Open C:\games\doom3\darkmod\currentfm.txt in your text editor and change the line to 'testmap' (without the quotes)

On next starting TDM you will be able to open the console and "dmap soundtest" or whatever you need. Once you're done with playing in your testmap you just revert the change in the text file. This also allows quick and easy changing between fm's without too much effort.


An Example : Adding a custom texture to your map

test texture
test texture

If you're set up and on your road to fm making glory now, please take the time to test how it all fits together by doing something like this. I assume you know how to use DarkRadiant and have made a very simple test map called texturetest in your C:\games\doom3\testmap\maps\ folder (the file would be texturetest.map) Please take note that we will be using a jpeg file, textures should never use jpegs for a number of reasons, however for the ease of demonstration we will in this case.


  • In your testmap folder create a new subfolder named "textures" and in there we will further organize it by making another subdirectory "smiley". Once created enter the "smiley folder"
  • Are you now in something like C:\games\doom3\testmap\textures\smiley ? you should be.
  • Right click the smiley face -> Save image as -> Browse to the smiley folder -> save as "smiley.jpg"
  • Is there now a smiley.jpg in the folder? if it's named incorrectly just rename it. If it's not there... try again.
  • Go back to your main testmap folder (C:\games\doom3\testmap\)
  • Create a new folder named "materials", then enter it
  • Create a new text file (right click in folder -> new -> text document) and rename it to something.mtr
  • Open something.mtr in your text editor of choice (eg Notepad, not Word or anything officey)
  • Paste the following block of text into the file and save it :
textures/mymaterials/smileyface
{
   wood
   diffusemap textures/smiley/yellowsmileyface
   // TDM Ambient Method Related
   {
       blend   add
       map     textures/smiley/yellowsmileyface
       red     global2
       green   global3
       blue    global4
   }
}
  • If you don't have DarkRadiant running, start it. If you do already have it started fo to file -> Reload Shaders.
  • In the material browser find your smiley face (click the textures folder once then press shift and the right arrow key to expand all folders. Once they are expanded click on a random material or folder there and just start typing "smiley"... that should do the trick!)


If you apply it to a brush in your test map then save it, you should be able to launch TDM using one of the methods shown in this document and after "dmap texturetest" "map texturetest" you should be able to see it ingame!