CharacterSheet 1.2.1

Author: Kevin Searle

Charsheet/1.2.1/charsheet.js

@@ -0,0 +1,79 @@
+/**
+ * Generates a blank character sheet for any player in the campaign.
+ *
+ * Syntax: !charsheet
+ */
+
+var Charsheet = Charsheet || {};
+
+on("chat:message", function(msg) {
+    // Exit if not an api command
+    if (msg.type != "api") {
+        return;
+    }
+
+    if (msg.content.indexOf('!charsheet') != -1) {
+        Charsheet.Generate(msg);
+    }
+});
+
+Charsheet.Generate = function(msg) {
+        var generatorversion = "1.2.1";
+        var playerid         = msg.playerid;
+        var player           = msg.who;
+
+        /**
+         * Templates
+         */
+        var template = {
+          "gmnotes": "Player: " + player +
+            "<br>Generated By: CharacterSheet " + generatorversion,
+          "charactername": msg.who + " #" +
+            (findObjs({_type: "character", controlledby: playerid}).length + 1)
+        }
+        template.channelalert = "created a character named \"" +
+          template.charactername + "\"!";
+
+        /**
+         * Permissions
+         *
+         * Valid values are "all" or comma-delimited list of player IDs.
+         */
+        /* Who can view the sheet */
+        var viewableBy   = "all";
+        /* Who can edit the sheet */
+        var controlledby = playerid;
+
+        /**
+         * Character generation
+         */
+        /* Create the base character object */
+        var character = createObj("character", {
+            name:             template.charactername,
+            archived:         false,
+            inplayerjournals: viewableBy,
+            controlledby:     controlledby
+        });
+        /* Set GM Notes */
+        character.set("gmnotes", template.gmnotes);
+        /* Set Player's name */
+        createObj("attribute", {
+            name:         "player_name",
+            current:      player,
+            _characterid: character.id
+        });
+        /* Set Character's name */
+        createObj("attribute", {
+            name:         "name",
+            current:      template.charactername,
+            _characterid: character.id
+        });
+        /* Set script version, used for debugging */
+        createObj("attribute", {
+            name:         "sheet_generator",
+            current:      "CharacterSheet v" + generatorversion,
+            _characterid: character.id
+        });
+
+        sendChat(player, "/me " + template.channelalert);
+};

Charsheet/README.md

@@ -1,3 +1,28 @@
-# charsheet
-Simple Roll20 character sheet creator
-Syntax: !charsheet
+# CharacterSheet
+
+A simple and easily customizable script allowing players to create their own
+character sheets.
+
+## Creating A Character Sheet
+
+Just type:
+
+`!charsheet`
+
+This will generate an empty character. It will be viewable by everyone in the
+campaign but only controllable by the player that ran the `!charsheet` command.
+
+The character's name will default to `PLAYER_NAME #X`, where `X` is a sequential
+number. In high-fatality games or multi-character funnels, this makes keeping
+track of characters a little easier.
+
+## Customizing
+
+A GM with minimal scripting knowledge should be able to customize the script to
+adapt to whatever game they are playing.
+
+It's easy to change:
+- sheet access permissions
+- default character naming
+- channel alert template
+- default GM notes

Charsheet/script.json

@@ -1,13 +1,16 @@
 {
-    "name": "CharacterSheet",
-    "script": "charsheet.js",
-    "version": "1.2",
-    "previousversions": [""],
-    "description": "A simple script to allow players to create their own character sheets. Using the command '!charsheet' will generate a character sheet controlled by the user that runs the command and visible in the journal to all players named 'Blank_Character'.",
-    "authors": "Base code by: GitHub user 'kevinsearle', Minor feature improvement and 1-click compatibility by: TECH",
-    "roll20userid": "446206",
-	"useroptions": [],
-	"dependencies": [],
-	"modifies": {},
-	"conflicts": []
-}
+  "name": "CharacterSheet",
+  "script": "charsheet.js",
+  "version": "1.2.1",
+  "previousversions": ["1.2"],
+  "description": "A simple and easily customizable script allowing players to create their own character sheets. Using the command '!charsheet' will generate a character sheet controlled by the user that runs the command and visible in the journal to all players.",
+  "authors": "Kevin The Barbarian,TECH",
+  "roll20userid": "565104,446206",
+  "useroptions": [],
+  "dependencies": [],
+  "modifies": {
+    "character": "write",
+    "attribute": "write"
+  },
+  "conflicts": []
+}