Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 2.26 KB

File metadata and controls

49 lines (39 loc) · 2.26 KB

SER 1.0 documentation

This directory is the canonical user documentation for the in-development Scripted Events Reloaded 1.0 release. It lives beside the implementation so a change to syntax, commands, examples, or tooling can update the matching tutorial in the same pull request.

Start here:

  1. Install SER
  2. Create and run your first script
  3. Understand files, names, and reloads
  4. Learn methods and values
  5. Learn variables and properties
  6. Add conditions and loops
  7. Work with collections
  8. Pause and resume execution safely
  9. Connect scripts to commands and events
  10. Organize larger scripts
  11. Debug a script

For complete examples that are compiled during every build, see the example index. Experienced authors can use the compact language specification.

Documentation boundaries

  • The implementation and build-generated ser_method_info.js are the source of truth for available methods, flags, events, variables, and properties.
  • serhelp exposes that information on the running server. It should be used instead of copied snapshots of hundreds of symbols.
  • SER Blocks teaches a deliberately small beginner vocabulary. The VS Code extension and text format expose the complete language.
  • The old German and Italian GitBook pages have not been migrated because they describe older syntax. See translation policy.

Contributing

Keep tutorials task-oriented. A beginner should know what a command changes, what they should see after running it, and which diagnostic command to use when the result differs.

When changing the language or user workflow:

  1. update the relevant page here;
  2. update a build-validated script in Example Scripts when appropriate;
  3. update language_specification.md for grammar changes;
  4. run npm run verify from Tooling;
  5. build SER so all bundled examples compile.