diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7b0cce7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +docs/_site +docs/Gemfile.lock \ No newline at end of file diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..e69de29 diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..3ef5ee6 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' +gem 'github-pages' +gem 'webrick' \ No newline at end of file diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..d29cff5 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 Eduardo Rubio + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..dfa433b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,21 @@ +# Documentation + +Compass is a Jekyll theme designed with something very specific in mind: to be a simple and elegant personal landing page that can be easily deployed to [GitHub Pages](https://pages.github.com/). + +## How to use Compass + +1. Start by [installing Bundler](http://bundler.io) `gem install bundler` +2. [Fork the Compass repository](https://github.com/excentris/compass/fork) +3. Clone the repository you just forked: `git clone https://github.com/YOUR-USER/compass` +4. Then run `bundle install` to get [Jekyll](http://jekyllrb.com) and all the dependencies. +5. Edit `_config.yml` as needed. +6. Run the Jekyll server with `bundle exec jekyll serve` +7. Go to `http://localhost:4000` + +## Deploy your site to GitHub Pages + +If you want to use Compass as your personal landing page you can deploy your site to GitHub Pages as a [User Page](https://help.github.com/articles/user-organization-and-project-pages/#user--organization-pages). To do so, when you are done modifying your clone, you should rename your repository to `username.github.io` where username is your username. When GitHub builds the page it will be made available at `https://username.github.io`. + +If you are planning on using a custom domain to direct to your site, modify the CNAME file as described [here](https://help.github.com/articles/adding-a-cname-file-to-your-repository/). + +Check the [GitHub Pages Basics](https://help.github.com/categories/github-pages-basics/) for more information. diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..38d67ca --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,33 @@ +# general configuration +url: https://spice2x.github.io/spice2x +baseurl: '' + +# compass configuration +compass: + # an avatar or logo (optional) + # logo: "/images/compass.png" + # author will appear under the avatar (optional) + author: "spice2x" + title: "spice2x" + # tagline will appear under the title (optional) + tagline: "a SpiceTools fork" + description: "spice2x is an updated version of SpiceTools with many new features and quality of life improvements." + # if include_content is true, the contents of the content.html include will be + # added right above the generated item list, if present + include_content: true + # if include_analytics is true, the content of the analytics.html include will + # be added at the end of the section. You can add your Google Analytics + # Tracking Code to that file. + include_analytics: false + # Twitter @username (as defined by the Twitter Card specs) + # twitter: "" + +# exclude +exclude: ["CNAME", "Gemfile", "Gemfile.lock", "LICENSE", "README.md"] + +# Dependencies +markdown: kramdown +highlighter: rouge + +# Permalinks +permalink: pretty diff --git a/docs/_includes/analytics.html b/docs/_includes/analytics.html new file mode 100644 index 0000000..17bca4a --- /dev/null +++ b/docs/_includes/analytics.html @@ -0,0 +1,2 @@ + diff --git a/docs/_includes/content.html b/docs/_includes/content.html new file mode 100644 index 0000000..41b77d2 --- /dev/null +++ b/docs/_includes/content.html @@ -0,0 +1,143 @@ +

about spice2x

+

spice2x is a fork of SpiceTools, focused on addressing bugs, usability, and quality-of-life improvements.

+ +

spice2x binaries are meant to be drop-in replacements for existing installs (spice.exe, spice64.exe, spicecfg.exe). + For a list of features, check out this page. +

+ +

GitHub pages, hosting environment for this page, has aggressive caching policies. +Force refresh (ctrl+F5) to get the latest contents for this page. +

+ + + +

latest stable download

+ +

Last updated on: February 13th, 2024.

+ + + +

past versions

+ +For older versions, please see Releases page. + +

wiki pages

+ + + +For more, please visit the wiki home. + +

suggested addons

+ +Check out these cool tools that can be used with spice: + + + +

disclaimers

+ +

spice2x team does not provide any tools to circumvent software copy protection, nor distribute any copyright-protected game data.

+ +

We are not associated with the original SpiceTools developers. + SpiceCompanion apps are also separate projects owned by the app developers. + Efforts will be made to keep up to date with upstream changes.

+ +

+If you want to run spice2x on a real arcade cabinet, do note that the developers take no responsibility for any damage done to your hardware. + +For example, some modes in certain games are known to push (practically permanent) firmware onto I/O boards. +While efforts have been made to hook some of these codes from running, there is no guarantee that this will always work (e.g., if newer version of the game decides to a +new method that isn't hooked). It is also no means comprehensive, as there may be yet-to-be-discovered code that may render your expensive hardware completely useless. +

+ +

issues, questions, bugs, feature requests

+ +Please use the github repo below. + +
+ + diff --git a/docs/_includes/head.html b/docs/_includes/head.html new file mode 100644 index 0000000..4415364 --- /dev/null +++ b/docs/_includes/head.html @@ -0,0 +1,53 @@ + + + + {% if site.compass.author %}{{ site.compass.author }} - {% endif %}{{ site.compass.tagline | strip_html }} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {% if site.twitter.site %} + + {% endif %} + {% if site.twitter.creator %} + + {% endif %} + + + + + {% if site.compass.include_analytics %} + {% include analytics.html %} + {% endif %} + + + + + + diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html new file mode 100644 index 0000000..684ee2d --- /dev/null +++ b/docs/_layouts/base.html @@ -0,0 +1,9 @@ + + + {% include head.html %} + + + {{ content }} + + + diff --git a/docs/archive.md b/docs/archive.md new file mode 100644 index 0000000..41e6644 --- /dev/null +++ b/docs/archive.md @@ -0,0 +1,19 @@ +--- +layout: base +nav_exclude: true +sitemap: false +--- + +
+
+ archived spice2x downloads +
+
+
+

+ These are old archived files. For latest version, visit https://spice2x.github.io/ +

    +
+
+
+
\ No newline at end of file diff --git a/docs/assets/main.scss b/docs/assets/main.scss new file mode 100644 index 0000000..f3a1b52 --- /dev/null +++ b/docs/assets/main.scss @@ -0,0 +1,207 @@ +--- +--- + +$text-color: #46433A; +$anchor-text-color: #CE534D; +$background-color: #F1EED9; + +body { + font-family: 'Vollkorn', serif; + color: $text-color; + background-color: $background-color; +} + +header, +main { + padding: 0 20px; +} + +/*** wrapper div for both header and main ***/ +.wrapper { + margin-top: 4%; +} + +/*** anchor tags ***/ +a:link, +a:visited, +a:hover, +a:active { + color: $anchor-text-color; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + + +/*** main content list ***/ +.main-list-item { + font-weight: bold; + font-size: 1.2em; + margin: 0.8em 0; +} + +/* override the left margin added by font awesome for the main content list, +since it must be aligned with the content */ +.fa-ul.main-list { + margin-left: 0; +} + +/* list icons */ +.main-list-item-icon { + width: 36px; + color: $text-color; +} + +/*** logo ***/ +.logo-container { + text-align: center; +} + +.logo { + width: 96px; + height: 96px; + display: inline-block; + background-size: cover; + border-radius: 50%; + -moz-border-radius: 50%; + border: 2px solid $background-color; + box-shadow: 0 0 0 3px $text-color; +} + +pre { + font-size: 0.75em; +} + +ul.downloads, ul.downloads-beta { + list-style-type: none; + padding-left: 0; +} + +ul.downloads > li, ul.downloads-beta > li { + margin-bottom: 24px; +} + +ul.downloads li img, ul.downloads-beta li img { + width: 94%; +} + +ul.downloads li, ul.downloads-beta li { + font-size: 0.96em; +} + +ul.downloads li a.download-link, ul.downloads-beta li a.download-link { + font-size: 1.4em; + font-weight: lighter; +} + +ul.downloads li a.download-link { + color: #cfa6a5; +} + +ul.downloads-beta li a.download-link { + color: #d37876; +} + +ul.downloads.highlight-latest li:first-child a.download-link { + font-weight: bold; + color: #CE534D; +} + +ul.downloads.highlight-latest li:first-child a.download-link::after { + content: " (latest)"; +} + +ul.downloads-beta.highlight-latest li:first-child a.download-link { + font-weight: bold; + color: #CE534D; +} + +ul.downloads-beta.highlight-latest li:first-child a.download-link::after { + content: " (latest beta)"; +} + +/*** author ***/ +.author-container h1 { + font-size: 2.4em; + margin-top: 0; + margin-bottom: 0; + text-align: center; +} + +/*** tagline ***/ +.tagline-container p { + font-size: 1.3em; + text-align: center; + margin-bottom: 2em; +} + +/******/ +hr { + border: 0; + height: 1px; + background-image: -webkit-linear-gradient(left, rgba(0,0,0,0), $text-color, rgba(0,0,0,0)); + background-image: -moz-linear-gradient(left, rgba(0,0,0,0), $text-color, rgba(0,0,0,0)); + background-image: -ms-linear-gradient(left, rgba(0,0,0,0), $text-color, rgba(0,0,0,0)); + background-image: -o-linear-gradient(left, rgba(0,0,0,0), $text-color, rgba(0,0,0,0)); +} + +/*** footer ***/ +footer { + position: fixed; + bottom: 0; + right: 0; + height: 20px; +} + +.poweredby { + font-family: "Arial Narrow", Arial; + font-size: 0.6em; + line-height: 0.6em; + padding: 0 5px; +} + +/*** media queries ***/ +/* X-Small devices (phones, 480px and up) */ +@media (min-width: 480px) { + /* wrapper stays 480px wide past 480px wide and is kept centered */ + .wrapper { + width: 480px; + margin: 4% auto 0 auto; + } + + main { + margin-bottom: 80px; + } +} + +/* All other devices (768px and up) */ +@media (min-width: 768px) { + /* past 768px the layout is changed and the wrapper has a fixed width of 680px + to accomodate both the header column and the content column */ + .wrapper { + width: 680px; + } + + /* the header column stays left and has a dynamic width with all contents + aligned right */ + header { + float: left; + width: 20%; + text-align: right; + } + + .author-container h1, + .logo-container, + .tagline-container p { + text-align: right; + } + + main { + width: 70%; + margin-left: 30%; + margin-bottom: 100px; + padding: 0; + } +} diff --git a/docs/assets/normalize.css b/docs/assets/normalize.css new file mode 100644 index 0000000..458eea1 --- /dev/null +++ b/docs/assets/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..c46295f Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/images/gfdm_io.png b/docs/images/gfdm_io.png new file mode 100644 index 0000000..8fa2350 Binary files /dev/null and b/docs/images/gfdm_io.png differ diff --git a/docs/images/iidx_io.png b/docs/images/iidx_io.png new file mode 100644 index 0000000..be0260a Binary files /dev/null and b/docs/images/iidx_io.png differ diff --git a/docs/images/iidx_ticker.gif b/docs/images/iidx_ticker.gif new file mode 100644 index 0000000..7a38d0e Binary files /dev/null and b/docs/images/iidx_ticker.gif differ diff --git a/docs/images/spice2x-screenshot-20230312.png b/docs/images/spice2x-screenshot-20230312.png new file mode 100644 index 0000000..242802d Binary files /dev/null and b/docs/images/spice2x-screenshot-20230312.png differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..9d7d0ff --- /dev/null +++ b/docs/index.html @@ -0,0 +1,27 @@ +--- +layout: base +--- +
+
+ {% if site.compass.logo %} +
+ +
+ {% endif %} + + {% if site.compass.author %} +

{{ site.compass.author }}

+ {% endif %} + + {% if site.compass.tagline %} +

{{ site.compass.tagline }}

+ {% endif %} +
+
+ {% if site.compass.include_content %} +
+ {% include content.html %} +
+ {% endif %} +
+
diff --git a/docs/patches.json b/docs/patches.json new file mode 100644 index 0000000..9f1a416 --- /dev/null +++ b/docs/patches.json @@ -0,0 +1,34 @@ +[ + { + "gameCode": "M32", + "dateCode": 2022102400, + "name": "Skip Tutorial", + "description": "", + "type": "memory", + "preset": true, + "patches": [ + { + "dllName": "game.dll", + "dataDisabled": "0F87", + "dataEnabled": "90E9", + "dataOffset": 946042 + } + ] + }, + { + "gameCode": "M32", + "dateCode": 2022102400, + "name": "Infinite Stage", + "description": "Score may not save", + "type": "memory", + "preset": true, + "patches": [ + { + "dllName": "game.dll", + "dataDisabled": "0F85", + "dataEnabled": "90E9", + "dataOffset": 1143921 + } + ] + } +]