(Battlescribe-only) Behaviour for unit-scope upgrades:
To get the latest patch notes and the (very) occasional sneak previews we sometimes give, make sure to check out the Discord!
This is a migration of Yellowscribe, which was created by Yellow Man but we lost the ability to maintain it when he left the project.
Yellowscribe is a rewrite of the original Battlescribe to TTS mod (with which we are not affiliated at all); all credit for inspiration and the code for drawing measuring circles around models goes to thehivemind5. Yellow Man made some changes in this version to make life a bit easier:
- The Datasheet attached to the unit has been cleaned up and hopefully looks a bit better now
- A Crusade Card can be attached to each unit where you can keep track of crusade statistics (press scripting key 9 while hovering a model)
- He added an easy way to keep track of agenda tallies (explained in "How To")
- Changing wounds up and down is now more colorful!
- For models with changing characteristics based on wounds (brackets), the description of the model will now display whatever its current statistics are (instead of just *s)
- Army creation should be a little more organized and allows for the editing of unit names as well as assigning weapons that were not assigned properly (should fix some issues in the original where models wouldnt have weapons)
- Finally, the spawning of an army in the in-game mod should now be much much faster
If you have any questions, please don't hesitate to come to the support server.
This website is made to be used with the in-game mod. If you are familiar with the original Battlescribe2TTS, getting your army roster into TTS will be mostly similar. If you are not familiar with that process, please follow the steps below (explained in further detail later on).
- Create an army roster using Rosterizer and export it by going to File -> Export. You'll get a .regiztry file. (Alternatively, you can create your army roster using Battlescribe or one of the compatible tools like NewRecruit or Bluescribe, but this is not recommended for 10th edition. If you do, export the roster either by saving it (on a PC) or by exporting as a Battlescribe Roster file (on mobile). In either case, the exported file should be a .rosz file.)
- Upload your saved roster file to this website using "Upload" in the menu bar to the left. The uploaded roster will be stored for about 10 minutes after you finish editing it.
- Check the roster looks right, and if you want, you can also set/change custom names for units. There are also some settings you can change in the menu bar. Then click Submit all the way at the bottom of the roster list.
- Copy the code that your are given on this site after uploading your roster, and paste it into the box in the in-game mod.
Choose models that you want to use for each model type in each unit.
NOTE: you can assign a model to multiple different model cards at a time by selecting multiple model cards before selecting a model.
- Click "Create Army" and enjoy! For more information on how to use the scripting provided by Yellowscribe, see the "Scripting" section on this page.
Editing Your Roster
There are a few ways to edit the models and units in your roster:
- You can set a custom name for the unit. This will apply the custom name given to the model in a unit if it is a single-model unit (eg a character or vehicle), or to every model in the unit if the appropriate setting is selected in the settings menu.
You can assign or unassign weapons to models in the unit if they have unassigned weapons. PLEASE NOTE: not all units have unassigned weapons. This only happens when Yellowscribe can't tell which model or models should have a given weapon in the Battlescribe Data (this can happen for a variety of reasons), and shouldn't happen in 10th edition at all.
To assign a weapon to a model group, there will be some buttons in the "Unassigned Weapons" section on that model group. There can be up to three buttons that show up (depending on the number of models in the group):
- a button with the name of the weapon. This assigns the weapon to a single model in the group
- an "All" button. This assigns the weapon to every model in the group
- a "Unit" button. This assigns the weapon to every model in the unit
- There are several options in the settings menu that should be self-explanatory.
To Associate a model with a model card, simply click on the model card (or model cards) with which you want to associate the model (or models).
You can assign a model (or models) to multiple model cards by selecting multiple model cards before picking up any models; the subsequent model or models you pick up will be assigned to all the selected model cards at once.
You can assign multiple models to a model card (or cards) by picking up multiple models at once. When you assign multiple models to a model card, it will randomly select which model to use for each model in that model group from the assigned models.
Several scripts are attached to your units when they are created with this tool. Several of them are the same as the original Battlescribe2TTS, but a few of them are new (or have changed slightly). The sections below will describe what happens when a particular scripting button is pressed. The numbering refers to the scripting button number pressed, not necessarily a particular key (depending on your keybindings). To see what key your scripting buttons are assigned to, or to change your keybindings, go to the Configuration menu in TTS, go to controls, then scroll down to the Scripting Button section.
Scripting Button 1
This will show a datasheet for the unit just like it did in the original mod. However, the data within it has been reorganized and should (hopefully) look a bit nicer.
You can also highlight your units with the buttons that run along the bottom edge of the datasheet. To remove the highlight, click the grey button at the end of the row.
Additionally, when you highlight a unit, any measuring circles added to it (see 4 and 5 below) will be in the highlighted color and will not overwrite previous measuring circles in other colors. This allows you to have multiple measuring circles on a model at a time.
Scripting Button 2 or 3
This will either remove (2) or add (3) a wound to the model you are hovering over. This should work exactly the same as the original mod with the following differences:
- The model's wounds should be helpfully colored according to how damaged it is (green when fully healthy, red when almost dead, yellow somewhere in between)
- If the model has characteristics that change based on how many wounds it has, these characteristics will change in its description based on its current wounds
Scripting Button 4 or 5
Expands (4) or shrinks (5) a measuring circle around the model over which you are hovering. A bonus feature has been added in this new version: a model can have multiple measuring rings around it at once. When a model is highlighted, it will produce a measuring ring in that color while also retaining any rings it had in other highlight colors (or in pink if it measured without a highlight).
Scripting Button 6 and 7
These do exactly what they did in the original version: switch which measuring ring is used for the model.
Scripting Button 8
This toggles whether the measuring ring should be circular or rectangular for the model.
Scripting Button 9
If Crusade Scripting is included (see the settings menu when editing your roster), this shows the unit's crusade card. The card is shared by all the models in the unit and should hopefully be useable as a way to track your units within TTS.
Scripting Button 10
If Crusade Scripting is included (see the settings menu when editing your roster), this shows the unit's agenda tally card. To use it, you must have an Agenda Manager spawned into the game and set up. The Agenda Manager is availible in the in-game mod on the top right corner of the table, simply save it and spawn it into whatever game you want to use it in. Details on how to use the Agenda Manager can be found below.
Currently there is only one function in a unit's right-click menu, but we may add more in the future, keep a look out!
Toggle Coherency check
This turns on coherency checking for the unit until it is turned off again the same way.
While checking coherency, any models in the unit that are out of coherency with other models will be
highlighted red. If all the models in the unit are in coherency (other than models that are out of coherency),
they will be highlighted green. If there are multiple (i.e. more than one) groups of models that are in
coherency with each other, but not with other groups, all such groups will be highlighted yellow.
Any face-down models in the unit will be completely ignored for the purposes of coherency checking. Coherency checking will automatically determine whether the unit has 6 or more models (and thus requires two models in coherency for each model), and should also handle vertical coherency checking fairly well (though we can't guarantee that vertical checking is completely accurate).
Coherency checking for models with oval bases is currently mostly imprecise (though it'll do an OK job). There is no particularly reasonable way of making it more precise.
The Agenda Manager is meant to help you keep track of agenda tallies (via spripting button 10 on your units), as well as provide a helpful display to help you remember which agendas you selected.
To use the Agenda Manager, first make sure to save the object (the little tile with a button on it at the top left of the table in the in-game mod). Once you're in a game and getting set up for a battle, spawn in your Agenda Manager and follow these steps:
Click the "Associate Models" button on the Agenda Manager. This tells the Agenda Manager that you have started associating models (and units) with it so that it keeps track of agendas for those units.
While the Agenda Manager is in this "associating models" mode, any object you pick up will be associated with the Agenda Manager. When a model is associated with the Agenda Manager, it will be highlighted in green until you finish associating models.
Note: you do NOT need to pick up the models you want to associate with it all at once, you can do them in batches, one at a time, all at once, it doesn't really matter. The Agenda Manager will keep associating models with itself until you click the "Finish" button.
If you accidentally pick up some object that isn't one of the models that you want to associate with it, it's OK: associating an object with the Agenda Manager only does something if that object is capable of showing a tally card (scripting button 10 on your units).
- Click the "Finish" button to stop associating models
- Select the battle size you are playing
- Fill out the agendas you have selected
- Click the "Accept" button to lock in your agendas, And now you should be able to see your agenda tallies when you hit scripting button 10 on your units!
Ran into a problem?
Please make sure you have your .regiztry (or .rosz/.ros) file handy as we will need it to try and replicate whatever issue is giving your trouble. If we don't have your .regiztry/.ros/.rosz file, it will be much much harder for us to fix the problem.
Once you have your .regiztry/.ros/.rosz file ready, or if you have any questions, please don't hesitate to come to the support server. If you are reporting an issue, make sure you do so in #report-here and include the .regiztry/.ros/.rosz file. (If you don't include your .regiztry/.ros/.rosz file in the bug report, we will invariably ask you for it anyway.)
If you are interested in taking a look at the code for this project, you can find the sources for it in our GitHub. Pull requests are welcome, though please discuss your plans with us before you jump into coding!
Again, if you have any questions, please feel free to jump into the support server and go to #code-discussion.