FAQ-SystemBuilder

From Let's Role
Jump to navigation Jump to search

System-builder-logo.png

Disclaimer

Here is a list of frequently asked questions about SystemBuilder posted on 🇫🇷 French part of Let's Role! Discord. Answers provided below only engage the users who posted them. They result from their experience of SystemBuilder. They do not reflect Let's Role! team's opinions in any way and cannot therefore be taken as official — or even fully proven.

This FAQ is now integrated (in a slightly different form) into Let's Role! Help Center : https://lets-role.com/help/en/system-builder/.

Links

Q) SystemBuilder webpage

Where can I find SystemBuilder webpage? I don't see any link on Let's Role! website to access it.

A) SystemBuilder webpage

There is no direct link named SystemBuilder. On Let's Role! website, follow Welcome,(Your Name) > Systems > +Create a New System.
  • P.S.: proceed in the same way to update your System under development, but following, after the Systems step, (Your System) > General > Enter the System Builder.

Q) Newbie developer

I have just started as a developer on Let's Role!. Where may I go to start?

A) Newbie developer

Follow this wiki link.
You can easily find documentation online as well as free courses about the development language used in SystemBuilder, javascript. For example: https://javascript.info/. Same thing for Boostrap: https://getbootstrap.com/docs/4.0/.
Then get help from the Discord benevolent Community (the Forums being not so busy), and don't hesitate to ask all kinds of questions. However, before asking them, try to make sure (using Discord search function) someone hasn't already done that (and maybe got answers).
  • P.S.: maybe some answers to your questions are already on the page you are reading presently.
75 - Argh! Hit in the left leg! F… it hurts… I can't believe it, maybe it's just a bug in your f… System, isn't it? — Anonymous player Creative Commons Attribution 3.0 License

Malfunctions

Q) Modifications not taken into account

I made some changes to my System in SystemBuilder, but when I run it, these changes are not reflected. Is there something I did wrong?

A) Modifications not taken into account

Often save and then Commit (Publish) your System in SystemBuilder (it will be published, but will not be available in Let's Role! Shop), in the process, solves many problems. You risk nothing to try it. Your successive Commits will be stored in Let's Role! website > Welcome,(Your Name) > Systems > (Your System) > Commits. You may restore an old version (Commit) of your System at any time (see Load a Commit).

Q) Lost my latest edits

I saved my System and/or made a Commit (Publish) of my System and/or ran my System in SystemBuilder, then I quit (possibly) SystemBuilder, but when I came back into SystemBuilder all my latest changes were gone. What happened?

A) Lost my latest edits

Sometimes, when your modifications contain errors, SystemBuilder seems to “forget” or “skip” on all these modifications and resets your System to the last backup preceding them.

Q) It doesn't work — Why?

I wanted to save my System and/or Commit (Publish) my System and/or run my System in SystemBuilder or in a Table outside SystemBuilder, but it didn't work. Is there something I did wrong?

A) It doesn't work — Component ID

If you are creating or updating one of your System sheets, try to see if there are any duplicates in your component ID labels. SystemBuilder usually prevents you from using the same ID twice for different components by throwing an error message and re-generating a random ID; but lo and behold, sometimes the situation gets out of hand, two components end up with the same ID (you're the source of it, overconfident that you're in the tech) and it results in an ID conflict. If so, resolving this ID conflict is definitely the solution to your problem.
  • P.S.: it is not always possible to modify an ID in Graphic Editor (for example, when it is one of a view). In this case, go to Source Editor. Then select all JSON code, copy and paste it into the window of a code editor application present on your computer (like NotePad on Windows), then make a backup (Save) of this file on your hard disk. This will serve as a backup if things go wrong in the next operation. Then look for the faulty duplicate ID (by doing a ctrl-F on PC or a command-F on Mac) in the SystemBuilder Source Editor window, then edit it (change it to xvxvxvxvxvxv for example). Be very careful, don't modify anything else in JSON code. Then try to save your System again. With any luck, that should work. Remember: if something goes wrong, you have a backup.

A) It doesn't work — Computed

If you have inserted a command in the text area of ​​a component for which you have checked the Computed box and there are one or more errors in this command (red-colored text is displayed at the bottom right of the window when you select this very component), this may prevent you from saving your System and/or Committing (Publishing) and/or running it. If so, debugging your command (or temporarily unchecking the Computed box, for that purpose) is definitely the solution to your problem.

A) It doesn't work — Tables

If you have created Tables (at the right of Views in SystemBuilder), for your Choices or for your Tabs for example, try to check their consistency. One or more inconsistencies in one or more Tables may prevent you from saving your System and/or Committing (Publishing) and/or running it. If so, restoring this consistency is definitely the solution to your problem.

A) It doesn't work — Script

If you have associated a script with your System, one or more errors in this script may prevent you from saving your System and/or from Committing (Publishing) and/or from running it. If this is the case, debugging your script, checking the syntax and inserting log() at strategic points for example (or temporarily commenting out all faulty code lines, for this purpose) is definitely the solution to your problem.

Managing my System

Q) Creating my first System

But I can't code in javascript (I'm not a developer)! I'm not going to get into creating a System under SystemBuilder because it's really not for me! I need to find someone who will do it for me…

A) Creating my first System

If you have a little trouble getting started on SystemBuilder, first start by drawing the views of your sheet on paper or on any other medium that you know. Clearly identify the different types of components as well as their organization in rows and columns. Only then transfer your sheet to SystemBuilder: organizing the "layout" of the sheet under SystemBuilder is quite intuitive and fun. And there, no need to know how to code in javascript.
Afterwards, a good soul, seeing the superb result you will have obtained, will not hesitate to "program" the dice rolls; Again, no need to know how to code in javascript. Dice rolls are obtained with almost the same formulas that you already use in the chat to throw them.
Still after, if someone wants to automate some functions, yes, some javascript code will be needed…
But all this is done in stages. And it's rather simple enough to find collaborators on a project that has already made a little progress than to bring them together from scratch.

Q) Publishing my System

How do I publish my System? There are two places on Let's Role! website that mention publishing my System; I do not understand anything anymore!

A) Publishing my System

Indeed Let's Role! offers you to publish your System, once in the SystemBuilder ('Publish' button which turns into 'Commit' button) and a second time by following Let's Role! website > Welcome,(Your Name) > Systems > (Your System) > General > Your system is not published. > Publish This System.
1- In SystemBuilder, this option allows you to create and/or update your System on Let's Role! (it will be published, but will not be present in Let's Role! shop). You can then use and/or share your System with whoever you want: Creating a Table outside SystemBuilder to test my System.
2- Regarding the second mention, this option allows you to effectively publish your System to Let's Role! shop: Publishing my System to the Shop. The entire community will then be able to use your System. NB: you must have also published your System in SystemBuilder so that it will be accessible from the Shop when you publish it to this one.

Q) Loading a Commit

I have ruined the latest version of my System with my hazardous modifications and I would just like to put it in the trash. Luckily I had been doing regular Commits! How can I restore an old version (Commit) of my System which was certainly less advanced, but which had the advantage of functioning correctly?

A) Loading a Commit

On Let’s Role! website, follow Welcome,(Your Name) > Systems > (Your System) > Commits. Clicking on the wrench to the right of an old version will load that version of your System into SystemBuilder; it will replace (overwrite) the last working version in it. Clicking the asterisk to the right of an older version will make that version available when creating/re-opening a Table using your System; all users will then use this version of the System.

Q) Inviting players to the Table created from SystemBuilder

I invited my players to my Table created from SystemBuilder, but when entering this Table as GM from clicking on My Tables link, Let's Role! displays a beautiful black screen and my System can't operate! Is there something I did wrong?

A) Inviting players to the Table created from SystemBuilder

This seems to confuse more than one System designer. The Table that was created from SystemBuilder (easy to recognize, its name starts with [Builder] if you haven't modified it) was created for testing and simulation purposes; it is therefore not operational outside the latter. Consequently, you must not invite players to connect to it, because it will be impossible for you to connect to it yourself as a GM following Let's Role! website > My Tables. This will inevitably result in the display of a black screen. Prefer this solution: Creating a Table outside SystemBuilder to test my System with my players.  

Q) Inviting one or more collaborators to work on my System

I need help developing my System (or someone has offered to help me). How do I invite someone to collaborate on my System?

A) Inviting one or more collaborators to work on my System

 You must first contact your future collaborator so that he sends you the email address with which he registered on Let's Role!. Once you have the email, on Let's role! website, follow Welcome, (Your Name) > Systems > (Your System) > Collaboration > Invite collaborators > User's email…, enter the email of your future collaborator then validate by clicking Send Invitation. Your new collaborator will have to follow Welcome,(His/Her Name) > Systems > Collaborations, then validate his/her collaboration to your System.
  • P.S.: you will not all be able to work on your System at the same time. When one is connected to it, he will have to close his SystemBuilder session to make room for the other/another. If you try to connect to your System on SystemBuilder while one of your collaborators is editing it, or has simply opened a SystemBuilder session with your System, an error message will occur.

Q) Creating a Table outside SystemBuilder to test my System

I just created my System. Now, I would like to be able to use it by selecting it in the menu when I create a new Table, without making it available in Let's Role! Shop. How do I proceed?

A) Creating a Table outside SystemBuilder to test my System

It is impossible in this way, as long as your System is not made available in Let's Role! Shop. However, you can do it another way: Commit (Publish) your System in SystemBuilder (it will be published, but will not be available in Let's Role! Shop). Then, on Let's Role! website, follow Welcome, (Your Name) > Systems > (Your System) > General > Share Your System. Copy the displayed link, paste it into the navigation bar of a browser window, open it and then, in the opened page, click +Create New Table. It also works for your players to create a character: +Create New Character.
  • P.S.: You can also include this private link into an email or text message that you shall send to your players.
  • P.S. 2: Don't forget to invite them to your Table afterwards.
  • P.S. 3: You may also wish to share this link with one or more testers who will also create a Table using your System.
  • P.S. 4: you can generate a new private link at any time; the old one will then be invalidated.

Q) Publishing my System to the Shop

That's it, my System is up and running, I tested it as a GM with my players - out of SystemBuilder, on a Table that I created for these circumstances (see Create a Table outside SystemBuilder to test my System); the game went well and everything worked perfectly. I therefore wish to make my System available in Let's Role! Shop to share it with the Community. How do I proceed?

A) Publishing my System to the Shop

Commit (Publish) your System in SystemBuilder (it will be published, but will not be available in Let's Role! Shop for the moment). Then, on Let's Role! website, follow Welcome,(Your Name) > Systems > (Your System) > General > Your System is not Published. Simply change the associated button state.
  • P.S.: remember to inform the Community by registering your System on the 🇬🇧 wiki Systems list and also possibly on the 🇫🇷 wiki Systems list.
  • P.S. 2: you may also announce it on the Discord where a moderator will pin your post.

Q) Translating my System to another language

I would like to translate my System interface into another language (or someone has offered to help me do this). How do I proceed?

A) Translating my System to another language

 To be done

Q) Proposing my help to translate a System to another language

I spotted a System whose interface I could probably translate (in my own language or in another that I master) if only I could contact its author. How do I proceed to contact him/her and offer him/her my help?

A) Proposing my help to translate a System to another language

 To be done

SystemBuilder Versions

Q) New SystemBuilder

I heard about the coming of a new version of SystemBuilder.
1- Will I be allowed to continue developing my old System under the old version of SystemBuilder or will I have to upgrade this System after the new version is deployed?
2- Will I be allowed to choose which version of SystemBuilder I want to use to develop my future Systems after the new version is deployed?

A) New SystemBuilder

1- Yes you will; it will be possible to stay in SystemBuilder v1 or to convert your old System to SystemBuilder v2, which will require modifying your script a little, even if the API will be similar.
2- No you won't, after new SystemBuilder is deployed, you will only be allowed to develop newly-created Systems under this very one.