forked from acenturyandabit/polymorph
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1889b3a
commit 2259b74
Showing
9 changed files
with
475 additions
and
468 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,43 @@ | ||
| // rich text | ||
| polymorph_core.markdownToHTML = (markdown) => { | ||
| // convert markdown into HTML | ||
| return | ||
| } | ||
| (() => { | ||
| // rich text | ||
| polymorph_core.RTRenderProperty = (prop) => { | ||
| // convert markdown into HTML | ||
| return prop; | ||
| } | ||
|
|
||
| polymorph_core.HTMLToMarkdown = (innerHTML) => { | ||
|
|
||
| } | ||
| polymorph_core.RTParseElement = (el, id, prop) => { | ||
| // check if there are any child images | ||
| let deepCloned = el.cloneNode(true); | ||
| let strayImages = 0; | ||
| if (deepCloned.children) { | ||
| for (c of deepCloned.children) { | ||
| if (c.tagName == "IMG" && c.src.slice(0, 5) == "data:") { | ||
| strayImages++; | ||
| let rq = new XMLHttpRequest(); | ||
| rq.onreadystatechange = (e) => { | ||
| if (rq.readyState == XMLHttpRequest.DONE) { | ||
| if (rq.status == 200) { | ||
| c.src = `${window.location.protocol}//${window.location.host}/getImage/${rq.responseText}.png`; | ||
| } | ||
| strayImages--; | ||
| if (strayImages == 0) { | ||
| // send an updateItem | ||
| polymorph_core.items[id][prop] = deepCloned.innerHTML; | ||
| polymorph_core.fire("updateItem", { id: id, sender: polymorph_core }); | ||
| } | ||
| } | ||
| } | ||
| rq.open("POST", `${window.location.protocol}//${window.location.host}/saveImage`); | ||
| rq.setRequestHeader('Content-Type', c.src.split(/;/g)[0].slice(5)); | ||
| rq.send(c.src); | ||
| } | ||
| } | ||
| } | ||
| // if there are, grab the url as a dataurl | ||
| // POST the dataurl to a backend image handler | ||
| // for now, just check whether localhost will take it | ||
| // when it comes back, fire an updateItem to update it. | ||
| return el.innerHTML; | ||
| } | ||
| })(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ## Data architecture | ||
| The main data repositories of Polymorph include: | ||
| - polymorph_core.userData: Device (browser) scope. | ||
| ```javascript | ||
| polymorph_core.userData={ | ||
| documents:{ | ||
| document_id:{ | ||
| saveSources:{ | ||
| saveSourceName:savesourceData | ||
| }, | ||
| autosave: true/false | ||
| } | ||
| }, | ||
| tutorialData:{ | ||
| operatorName:operatorTutorialData | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,19 @@ | ||
| # Overview | ||
|
|
||
| Polymorph is a highly modular system, which makes it fantastic for modding. | ||
| Polymorph is a highly modular system, which makes it fantastic for modding. The main classes of modules outside of the care are savesources and operators: | ||
|
|
||
| If you're only looking to mod polymorph by adding your own functionality, you may only need to know about the following structure: | ||
|  | ||
|
|
||
|  | ||
| - Operators operate on the data by rendering it and applying user edits to the underlying data. Operators also subscribe or publish to an event system allowing them to communicate with each other. | ||
| - Save sources operate on the data by saving it to a remote location for safekeeping between sessions. | ||
|
|
||
| There are also a number of core elements: | ||
| - Containers wrap around operators to help isolate operators from each other in a field-reconfigurable manner. | ||
| - Rects manage space by dividing the screen into rectangles. Each rect can either hold exactly two other rects; or an indefinite number of containers in tabs. | ||
| - The core event system relays events between operators and from operators to realtime savesources. | ||
| - The core document loading system reads both the local machine data and the document data to determine which save source instances and operators to create. | ||
|
|
||
| The unit of data in polymorph is an item. An item is a plain JSON-encoded entry in the document dictionary. Items can further have properties which are then rendered by operators. | ||
|
|
||
|
|
||
|
|
||
| ## It's like... | ||
| - ROS [https://www.ros.org/], but for user interfaces | ||
| - Outlook, but less integrated (sad) and more flexible (yay) | ||
| ## Software Architecture | ||
| Polymorph is made up of a few main components: | ||
| - polymorph_core: This represents a shared platform where everything interacts. It contains a main event interface. | ||
| - Rects: This represents resizable rectangles that form the basis of Polymorph's UX. | ||
| - Containers: Rects hold containers, which hold operators. Containers abstract away some common UX concerns from operators. | ||
| - polymorph_core modules: These represent aspects of the polymorph_core's operation. | ||
| - Items: These are created by users through operators. | ||
| - [MODDING FOCUS] Operators: These represent different ways of representing, interacting with and creating items. | ||
|
|
||
| ## Data architecture | ||
| The main data repositories of Polymorph include: | ||
| - polymorph_core.userData: Device (browser) scope. | ||
| ```javascript | ||
| polymorph_core.userData={ | ||
| documents:{ | ||
| document_id:{ | ||
| saveSources:{ | ||
| saveSourceName:savesourceData | ||
| }, | ||
| autosave: true/false | ||
| } | ||
| }, | ||
| tutorialData:{ | ||
| operatorName:operatorTutorialData | ||
| } | ||
| } | ||
| ``` | ||
| - polymorph_core.items: Instance scope. | ||
| ## Living architecture | ||
| [Back to contents](https://github.com/acenturyandabit/polymorph/tree/master/docs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.