├── .gitignore ├── LICENSE ├── README.md ├── assets ├── background.png ├── favicon.ico ├── rule.png ├── scripts.js ├── scripts.min.js ├── style.css ├── style.css.map ├── style.min.css └── style.scss ├── index.html └── netlify.toml /.gitignore: -------------------------------------------------------------------------------- 1 | prepros.config 2 | node_modules -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2017 Keno Clayton 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Steam Review Editor 2 | 3 | Steam Review Editor allows you to easily create and modify your reviews in real-time, without having to manually apply steam's complex markup tags. 4 | 5 | --- 6 | 7 | ## Usage 8 | 9 | Simply type your review, hit "Copy to Clipboard", and paste it in Steam! 10 | 11 | While the markup is automatically applied, there are currently a few elements that may require your modification before publishing your review. 12 | 13 | 1. Blockquotes by default, have an author value of "author". Modify this to your liking, or omit it completely. 14 | 15 | ## Resources 16 | 17 | * The text editor is [Quill](http://quilljs.com/) and is modified using CSS 18 | * The website is built with [Bootstrap v4.6.2](https://getbootstrap.com/docs/4.6/getting-started/introduction/) 19 | * The colours, as well as other layout ideas were mostly sourced from Steam's very own website: [Steam Store](http://store.steampowered.com) 20 | 21 | ## Contributions 22 | 23 | All contributions to the project are totally welcome. Anything that can improve the editor, website performance, layout or fix bugs are likely to be merged with the base project. 24 | -------------------------------------------------------------------------------- /assets/background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dons20/steam-review-editor/652c195f955699fb827c5d9e52333af67a571a8c/assets/background.png -------------------------------------------------------------------------------- /assets/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dons20/steam-review-editor/652c195f955699fb827c5d9e52333af67a571a8c/assets/favicon.ico -------------------------------------------------------------------------------- /assets/rule.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dons20/steam-review-editor/652c195f955699fb827c5d9e52333af67a571a8c/assets/rule.png -------------------------------------------------------------------------------- /assets/scripts.js: -------------------------------------------------------------------------------- 1 | window.addEventListener( 2 | "load", 3 | function load() { 4 | // Temporary workaround for Quill not loading properly 5 | if (!window.jQuery || !window.Quill) return setTimeout(load, 120); 6 | 7 | const Inline = Quill.import("blots/inline"); 8 | const BlockEmbed = Quill.import("blots/block/embed"); 9 | 10 | class SpoilerBlot extends Inline { 11 | static blotName = "spoiler"; 12 | static className = "spoiler"; 13 | static tagName = "span"; 14 | 15 | static create() { 16 | return super.create(); 17 | } 18 | 19 | static formats() { 20 | return true; 21 | } 22 | 23 | optimize(context) { 24 | super.optimize(context); 25 | if (this.domNode.tagName !== this.statics.tagName) { 26 | this.replaceWith(this.statics.blotName); 27 | } 28 | } 29 | } 30 | 31 | class DividerBlot extends BlockEmbed { 32 | static blotName = 'divider'; 33 | static tagName = 'hr'; 34 | } 35 | 36 | const steamDivider = function () { 37 | const range = quillInstance.getSelection(true); 38 | quillInstance.insertText(range.index, '', Quill.sources.USER); 39 | quillInstance.insertEmbed(range.index, 'divider', true, Quill.sources.USER); 40 | quillInstance.setSelection(range.index + 1, Quill.sources.SILENT); 41 | }; 42 | 43 | Quill.register("formats/spoiler", SpoilerBlot); 44 | Quill.register("formats/divider", DividerBlot); 45 | 46 | const Delta = Quill.import("delta"); 47 | const quillInstance = new Quill("#editor", { 48 | modules: { 49 | toolbar: { 50 | container: "#toolbar", 51 | handlers: { 52 | divider: steamDivider 53 | }, 54 | }, 55 | }, 56 | formats: [ 57 | "header", 58 | "bold", 59 | "italic", 60 | "underline", 61 | "strike", 62 | "blockquote", 63 | "code", 64 | "code-block", 65 | "divider", 66 | "spoiler", 67 | "list", 68 | "link", 69 | ], 70 | placeholder: "Write your review here!", 71 | theme: "snow", 72 | }); 73 | 74 | let text = quillInstance.container.firstChild.innerHTML; 75 | 76 | // Enable all tooltips 77 | $('[data-toggle="tooltip"]').tooltip(); 78 | 79 | let change = new Delta(); 80 | 81 | quillInstance.on("selection-change", function (range, oldRange, source) { 82 | text = quillInstance.container.firstChild.innerHTML; 83 | convertHTML(text); 84 | if (range) { 85 | $("#editorWindow").addClass("active"); 86 | } else { 87 | $("#editorWindow").removeClass("active"); 88 | } 89 | }); 90 | 91 | quillInstance.on("text-change", function (delta, oldDelta, source) { 92 | text = quillInstance.container.firstChild.innerHTML; 93 | convertHTML(text); 94 | change = change.compose(delta); 95 | }); 96 | 97 | /** 98 | * @param {string} convertText 99 | */ 100 | function convertHTML(convertText) { 101 | //Process the markup tags 102 | let markupText = convertText 103 | .replace(/
/g, "")
104 |         .replace(/<\/p>/g, "\n")
105 |         .replace(//g, "[b]")
106 |         .replace(/<\/strong>/g, "[/b]")
107 |         .replace(/ /g,"").replace(/<\/p>/g,"\n").replace(//g,"[b]").replace(/<\/strong>/g,"[/b]").replace(/
/g, "[hr][/hr]\n")
108 |         .replace(//g, "[h1]")
109 |         .replace(/<\/h1>/g, "[/h1]\n")
110 |         .replace(/
/g, "[h2]")
111 |         .replace(/<\/h2>/g, "[/h2]\n")
112 |         .replace(/
/g, "[h3]")
113 |         .replace(/<\/h3>/g, "[/h3]\n")
114 |         .replace(//g, "[i]")
115 |         .replace(/<\/em>/g, "[/i]")
116 |         .replace(//g, "[u]")
117 |         .replace(/<\/u>/g, "[/u]")
118 |         .replace(/
/g, "")
119 |         .replace(/<\/ol>/g, "")
120 |         .replace(/((
/g, "\n")
125 |         .replace(//g, "]")
127 |         .replace(/<\/a>/g, "[/url]")
128 |         .replace(//g, "[strike]")
129 |         .replace(/<\/s>/g, "[/strike]")
130 |         .replace(//g, "[quote=author]")
131 |         .replace(/<\/blockquote>/g, "[/quote]\n")
132 |         .replace(/()/g, "")
133 |         .replace(/(.*?)<\/span>/g, "[spoiler]$1[/spoiler]")
134 |         .replace(//g, "")
135 |         .replace(/<\/span>/g, "[/spoiler]")
136 |         .replace(/
/g, "[code]")
137 |         .replace(/<\/pre>/g, "[/code]\n")
138 |         .replace(/
/g, "[noparse]")
139 |         .replace(/<\/code>/g, "[/noparse]");
140 | 
141 |       let previewText = quillInstance.getSemanticHTML().replaceAll('', `
142 |         
143 |           
144 |       `);
145 | 
146 |       //Set the markup display
147 |       $("#markup").html(markupText);
148 | 
149 |       //Set the preview display
150 |       $("#preview").html(previewText);
151 |     }
152 | 
153 |     function CopyToClipboard(containerid) {
154 |       let t = document.createElement("textarea");
155 |       t.id = "t";
156 |       t.style.height = 0;
157 |       document.body.appendChild(t);
158 |       t.value = document.getElementById(containerid).innerText;
159 |       let selector = document.querySelector("#t");
160 |       selector.select();
161 |       selector.setSelectionRange(0, 99999); /*For mobile devices*/
162 |       navigator.clipboard.writeText(selector.value);
163 |       // Remove the textarea
164 |       document.body.removeChild(t);
165 |       alert("Markup copied to clipboard!");
166 |     }
167 | 
168 |     function pushFooter() {
169 |       let docHeight = $(window).height();
170 |       let footerHeight = $("#footer").height();
171 |       let footerTop = $("#footer").position().top + footerHeight;
172 | 
173 |       if (footerTop < docHeight) {
174 |         $("#footer").css("margin-top", 10 + (docHeight - footerTop) + "px");
175 |       }
176 |     }
177 | 
178 |     //Show Preview
179 |     $("#previewCollapse").on("show.bs.collapse", function () {
180 |       quillInstance.blur();
181 |       document.getElementById("showBtn").innerHTML = "Hide Preview";
182 |     });
183 | 
184 |     //Hide Preview
185 |     $("#previewCollapse").on("hide.bs.collapse", function () {
186 |       document.getElementById("showBtn").innerHTML = "Show Preview";
187 |       quillInstance.focus();
188 |     });
189 | 
190 |     $("#copyBtn").click(function () {
191 |       CopyToClipboard("markup");
192 |     });
193 | 
194 |     $("#closeBtn").click(function () {
195 |       $("#help").fadeOut(1000, function complete() {
196 |         pushFooter();
197 |       });
198 |     });
199 | 
200 |     // Save periodically
201 |     setInterval(function () {
202 |       if (change.length() > 0) {
203 |         // console.log("Saving changes", change);
204 |         change = new Delta();
205 |       }
206 |     }, 5 * 1000);
207 | 
208 |     // Check for unsaved data
209 |     window.onbeforeunload = function () {
210 |       if (change.length() > 0) {
211 |         return "There are unsaved changes. Are you sure you want to leave?";
212 |       }
213 |     };
214 | 
215 |     $(document).ready(function () {
216 |       pushFooter();
217 |       let fade = $(".fade");
218 |       fade.css({ opacity: "0" });
219 |       fade.fadeTo(500, 1, "swing");
220 | 
221 |       let today = new Date();
222 |       let day = today.getDate();
223 |       let monthName = today.toLocaleString("en-us", { month: "long" });
224 | 
225 |       $(".current-date").html(`${day} ${monthName}`);
226 |     });
227 |   },
228 |   false
229 | );
230 | 
--------------------------------------------------------------------------------
/assets/scripts.min.js:
--------------------------------------------------------------------------------
1 | window.addEventListener("load",(function e(){if(!window.jQuery||!window.Quill)return setTimeout(e,120);const t=Quill.import("blots/inline"),l=Quill.import("blots/block/embed");Quill.register("formats/spoiler",class extends t{static blotName="spoiler";static className="spoiler";static tagName="span";static create(){return super.create()}static formats(){return!0}optimize(e){super.optimize(e),this.domNode.tagName!==this.statics.tagName&&this.replaceWith(this.statics.blotName)}}),Quill.register("formats/divider",class extends l{static blotName="divider";static tagName="hr"});const o=Quill.import("delta"),i=new Quill("#editor",{modules:{toolbar:{container:"#toolbar",handlers:{divider:function(){const e=i.getSelection(!0);i.insertText(e.index,"",Quill.sources.USER),i.insertEmbed(e.index,"divider",!0,Quill.sources.USER),i.setSelection(e.index+1,Quill.sources.SILENT)}}}},formats:["header","bold","italic","underline","strike","blockquote","code","code-block","divider","spoiler","list","link"],placeholder:"Write your review here!",theme:"snow"});let r=i.container.firstChild.innerHTML;$('[data-toggle="tooltip"]').tooltip();let n=new o;function a(e){let t=e.replace(/
/g,"[hr][/hr]\n").replace(//g,"[h1]").replace(/<\/h1>/g,"[/h1]\n").replace(/
/g,"[h2]").replace(/<\/h2>/g,"[/h2]\n").replace(/
/g,"[h3]").replace(/<\/h3>/g,"[/h3]\n").replace(//g,"[i]").replace(/<\/em>/g,"[/i]").replace(//g,"[u]").replace(/<\/u>/g,"[/u]").replace(/
/g,"").replace(/<\/ol>/g,"").replace(/((
/g,"\n").replace(//g,"]").replace(/<\/a>/g,"[/url]").replace(//g,"[strike]").replace(/<\/s>/g,"[/strike]").replace(//g,"[quote=author]").replace(/<\/blockquote>/g,"[/quote]\n").replace(/()/g,"").replace(/(.*?)<\/span>/g,"[spoiler]$1[/spoiler]").replace(//g,"").replace(/<\/span>/g,"[/spoiler]").replace(/
/g,"[code]").replace(/<\/pre>/g,"[/code]\n").replace(/
/g,"[noparse]").replace(/<\/code>/g,"[/noparse]"),l=i.getSemanticHTML().replaceAll("",'\n        
\n          \n      ');$("#markup").html(t),$("#preview").html(l)}function c(){let e=$(window).height(),t=$("#footer").height(),l=$("#footer").position().top+t;l
Steam Review Editor
 26 |                 Store Preview
Markup Preview