---

---

Introduction
SMF Arcade adds an arcade section to your forum where users can play games.
You must uninstall any previous versions of the Arcade prior to updating this modification.

All your users should be using a modern mainstream browser with JavaScript support enabled for this modification to function as intended.


Supported SMF Versions
This version supports the most recent SMF 2.1 branch.
Support has been dropped for the SMF 2.0 branch.

Recommended Minimal Requirements
OS minimum recommended versions: Ubuntu 23, Centos Rocky 8
HTTP Server: Apache 2.4 using PHP 8.3
Database: MySQL / Maria DB (using UTF-8 Unicode)
Extensions/modules: curl, mbstring, zlib, phar, mime, rewrite, headers
Forum software/versions: SMF 2.1 branch ~ (using UTF-8 Charset)
Hypertext Transfer Protocol Secure (HTTPS) ~ HTTP over TLS or HTTP over SSL

Optional RAR compression support: RAR (command-line tool) -> shell_exec must be enabled in PHP to use RAR compression
Optional RAR decompression support: UNRAR (PECL RarArchive class) package for Unix -> Extension must be enabled in php.ini (check phpinfo() to confirm)
RAR archive package for PHP 7.3 (check other PHP versions): https://centos.pkgs.org/8/remi-x86_64/php73-php-pecl-rar-4.0.0-4.el8.remi.x86_64.rpm.html
RAR compression for Unix: Install rar via yum, DNF or apt-get -> example: yum install rar
RAR compression for WIndows: Requires WinRAR to be installed in -> Program Files / Program Files (x86)

To use the game description translation feature, you must register at Microsoft Azure Translator Service to use their V3 API.
After registration, you must enter the Azure V3 API endpoint, path, subscription key (and region code if applicable) information into your Arcade Administration settings.

Supported game types:

• HTML5 v1 (requires specific SMF Arcade save code)
• HTML5 v2 (IBP -> various HTML5 save codes)
• HTML5 v3 (PHPBB -> various HTML5 save codes)
• IBProArcade v1 / v2 / v3 / v3.2 (flash)
• vBulletin v3Arcade (flash)
• PHPBB (flash)
• MochiAds are supported with external module
• SMF v1 / v2 (flash)
• General flash games are supported without score support
• General HTML5 games are supported without score support
• ROM games are supported without score support via the EmulatorJS plugin

All Flash games use the Ruffle Flash Emulator. Many Flash games will work but not all of them due to Ruffle still being in active development.
The Ruffle Flash Emulator is no longer included with this installation package.
You can use the Arcade Maintenance page to download that third party package to host the files on your server or you can opt to use the remote CDN from the main Arcade settings page.

All ROM games are supported via the EmulatorJS plugin which can be downloaded to your server via the Arcade Maintenance page.
There is now a remote CDN available for EmulatorJS where this plugin only uses the CDN for the "/data" path.

[HTML5 / Flash / ROM] Games
You can view this link for information regarding games for this arcade system: GAME RESOURCE LIST

Games Playable Using This Arcade
The ability to play HTML5, Flash & ROM games is provided but finding sources for those games is left up to each webmaster.
No games are included with this package.

Notes regarding application and modification conflicts:
Mod-Security should be disabled for SMF-Arcade's HTML5/JQuery chunk upload scripts to function properly which is used for large sized game archives.
If you are insistent on using that application, FTP may be necessary to upload your game archives to SMF-Arcade's upload folder paths.

Pretty URL's modification for SMF is not recommended as it may cause compatibility issues with SMF-Arcade due to URL manipulation.
Support for SMF-Arcade issues arising from using that SMF mod or any type of modification that facilitates URL manipulation will not be provided.

[RAW-ROM & SMF-ROM] Game Formats
For this SMF-Arcade version, "raw" ROM game archives can only be uploaded as a zip or 7z archive.
Many "raw" ROM games are supported usually in a single file format ( [1 file] -or- [1 bin + 1 cue] ) but not all will function using EmulatorJS. You will need to use trial & error when installing ROM games in the "raw" format. These sourced games do not come with any set-up files or thumbnails therefore a random thumbnail is provided upon installation & it will be up to an Arcade-Admin to enter the description, help text & to replace the thumbnail if desired. The Arcade attempts to determine the console type during installation but will leave the game unset if the ROM file type can be used for multiple consoles or if it fails to detect it.

For this SMF-Arcade version, SMF-ROM game archives can only be uploaded as a zip archive.
SMF-ROM games are supported so long as they are working on another SMF-Arcade platform. Any thumbnails, description, help, console type, etc. should be included in its zip archive & will install similar to FLASH/HTML5 games in that respect.

At this time ROM games are void of score support although we are looking into adding this in an upcoming SMF-Arcade release. However, these game types do allow for saving progress to a file on the users device.

Features:

• Arena for users to challenge other users (disabled in this version)
• Category Champions as well as Arcade Champions
• Daily challenge
• Sort games
• Installs tar, tar.gz, zip and rar game files
• Admin settings for added features
• Notifications for high scores and tournament matches
• Responsive/mobile support
• Users can Report game errors
• Download game option
• Post new game to forum
• Alternate game templates available
• Option to allow auto adjustment of improper save types
• Allows other mods to use hooks containing score or match information
• Ability to add custom skins & lists via database entries
• Ability to use Flash games via the Ruffle emulator plug-in
• Ability to play a variety of ROM games via the EmulatorJS plug-in

Arcade Hooks | Custom Skins & Lists
For information regarding Arcade hooks, creating custom skins + lists and useful functions, please use this link:
Arcade Hooks & Plug-In Functions

Reporting Bugs
Please report bugs to the Official Support Thread!
This helps make this modification better!

Copyright (c) 2004 - 2012, Niko Pahajoki
Copyright (c) 2015 - 2024, Chen Zhen
Current support provided by Chen Zhen @ web-develop.ca
SMF Arcade License: BSD 2

Beta / RC  Testers:
Dave, Ronald, Skhilled, Bigguy, Legionaire, Origon, Hero, Vince, Lesmond, Rowdy

Many thanks to our beta testers and all those that provide feedback to help improve this modification package.

---

We would like to thank both Ruffle & EmulatorJS developers plus everyone involved in those projects for their time, effort & great work.
Both emulator projects are essential parts of SMF-Arcade, we are greatful for their contributions to the public domain & indirectly to this project.

EmulatorJS @ https://emulatorjs.org/
Owners, developers & contributors: Ethan O'Brien, Allancoding, Binbashbanana, Michael-J-Green, Electronicarchiver & all others involved.

Ruffle @ https://ruffle.rs/
Owners, developers & contributors: Michael Welsh, Kmeisthax, Nathan Adams & all others involved.

---

Disclaimer:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.