axmol/docs/index.html

205 lines
9.5 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Axmol Engine | A Multi-platform Engine for Mobile, Desktop and Xbox</title>
<meta name="generator" content="Jekyll v3.9.3" />
<meta property="og:title" content="Axmol Engine" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="The axmol home page" />
<meta property="og:description" content="The axmol home page" />
<link rel="canonical" href="https://axmol.dev/" />
<meta property="og:url" content="https://axmol.dev/" />
<meta property="og:site_name" content="axmol.dev" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Axmol Engine" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebSite","description":"The axmol home page","headline":"Axmol Engine","name":"axmol.dev","url":"https://axmol.dev/"}</script>
<!-- End Jekyll SEO tag -->
<link rel="preconnect" href="https://fonts.gstatic.com">
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="stylesheet" href="assets/css/style.css?v=fb4aeb0a15d8adcd11c824dee3f2322a9ffc5418"">
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
<!-- Setup Google Analytics -->
<!-- You can set your favicon here -->
<!-- <link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> -->
<!-- end custom head snippets -->
</head>
<body>
<a id="skip-to-content" href="#content">Skip to the content.</a>
<header class="page-header" role="banner">
<h1 class="project-name">Axmol Engine</h1>
<h2 class="project-tagline">A Multi-platform Engine for Mobile, Desktop and Xbox.</h2>
</header>
<main id="content" class="main-content" role="main">
<img src="logo.png" width="160">
<p><a href="https://github.com/axmolengine/axmol/releases"> <img src="https://img.shields.io/github/v/release/axmolengine/axmol?include_prereleases&amp;label=release" alt="release" /></a><a href="https://github.com/axmolengine/axmol/blob/dev/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="LICENSE" /></a></p>
<p>Index:</p>
<ul>
<li><a href="#what-is-axmol-engine">What is Axmol Engine</a></li>
<li><a href="#who-is-axmol-engine-for">Who is Axmol Engine for</a></li>
<li><a href="#advantages-of-axmol-engine">Advantages of Axmol Engine</a></li>
<li><a href="#community">Axmol Engine community</a></li>
<li><a href="#why-axmol-was-born">Why Axmol Engine was born</a></li>
<li><a href="#improvements-over-cocos2d-x">Some improvements over Cocos2d-x</a></li>
<li><a href="#faq">FAQ</a></li>
</ul>
<h1><a id="what-is-axmol-engine"></a>What is Axmol Engine</h1>
<p>Axmol Engine is an open-source, C++ multi-platform engine designed for mobile devices, desktop, and Xbox, well-suited for 2D game development. It was launched in November 2019 as a fork of Cocos2d-x v4.0.</p>
<p>Supported platforms:</p>
<ul>
<li>Mobile: iOS, Android</li>
<li>Desktop: Windows, Linux, macOS, tvOS</li>
<li>Console: Xbox (Universal Windows Platform)</li>
<li>Web: WebAssembly (Preview: <a href="https://axmol.netlify.app/wasm/cpp-tests/cpp-tests">Axmol tests</a> / <a href='https://axmol.netlify.app/wasm/fairygui-tests/fairygui-tests'>FairyGUI tests</a>)</li>
</ul>
<p>Languages:</p>
<ul>
<li>C++</li>
<li>Lua</li>
</ul>
<p>Download it:</p>
<ul>
<li><a href="https://github.com/axmolengine/axmol/releases">Latest Release</a></li>
<li><a href="https://github.com/axmolengine/axmol/blob/dev/docs/DevSetup.md">How to install</a></li>
</ul>
<p>Important links:</p>
<ul>
<li><a href="https://axmol.dev/manual/latest/">API Documentation</a></li>
<li><a href="https://github.com/axmolengine/axmol">GitHub</a></li>
<li><a href="https://github.com/axmolengine/axmol/wiki">Wiki</a></li>
<li><a href="https://github.com/axmolengine/axmol/blob/dev/LICENSE">Licence</a></li>
<li><a href="https://github.com/axmolengine/axmol/discussions/1231">Migration guide for Cocos2d-x users</a></li>
</ul>
<p>Projects:</p>
<ul>
<li>Please check our Wiki page <a href="https://github.com/axmolengine/axmol/wiki/Made-in-Axmol">Made in Axmol</a> for extensions, games, tutorials and more. If you're making anything Axmol related, please add it there!</li>
</ul>
<h1><a id="who-is-axmol-engine-for" "></a>Who is Axmol Engine for</h1>
<ul>
<li>For any game creator in need of a multi-platform engine.</li>
<li>For those who want to program mainly in C++.</li>
<li>For those who prefer a code-only engine, without a graphical user interface.</li>
<li>For those requiring a lightweight, stable, and proven solution compatible with older hardware.</li>
<li>For developers who need to update their Cocos2d-x projects.</li>
<li>For developers who want to port their Sprite Kit projects to Android.</li>
</ul>
<h1><a id="advantages-of-axmol-engine"></a>Advantages of Axmol Engine</h1>
<ul>
<li>Its free.</li>
<li>Open source, independent of any organization.</li>
<li>Its a tested and stable solution that has been evolving since 2011.</li>
<li>Well maintained, with an active community of contributors.</li>
<li>Abundant documentation and tutorials available online, as much of the existing Cocos2d-x documentation is applicable to Axmol Engine with minimal modifications.</li>
<li>High performance, featuring OpenGL 2.0 and Metal support.</li>
</ul>
<h1><a id="community"></a>Axmol Engine community</h1>
<p>Please join us!</p>
<ul>
<li><a href="https://github.com/axmolengine/axmol/discussions">GitHub Discussions</a></li>
<li><a href="https://discord.gg/TvY2nwPbQR">Discord</a></li>
<li><a href="https://www.reddit.com/r/axmol/">Reddit</a></li>
</ul>
<h1><a id="why-axmol-was-born"></a>Why Axmol was born (Why a fork of Cocos2d-x)</h1>
<p>Cocos2d-x has not received updates since 2019, and it has been confirmed that it will no longer receive further updates, as all Cocos resources have been directed to Cocos Creator. Axmol serves as the solution for those who wish to continue working with Cocos2d-x in an updated manner, compatible with newer hardware.</p>
<h1><a id="improvements-over-cocos2d-x"></a>Some improvements over Cocos2d-x v4.0</h1>
<ul>
<li>Supports the latest Android SDK out of the box</li>
<li>Uses C++20 instead C++11 or older</li>
<li>x86_64 and Apple Silicon support</li>
<li>Supports UWP (Xbox portability)</li>
<li>New MediaPlayer via videotexture streaming render</li>
<li>Lot of new extensions</li>
</ul>
<p><a href="https://github.com/axmolengine/axmol/blob/dev/CHANGELOG.md">Read the full improvements list here</a></p>
<h1><a id="faq"></a>FAQ</h1>
<h2><a id="what-does-the-engine-name-axmol-stands-for"></a>What does the engine name <code>Axmol</code> stands for?</h2>
<ul>
<li>
The Axmol word structure:
<ul>
<li>
<code>a</code>: one
</li>
<li>
<code>x</code>: unknown or comes from cocos2d-x
</li>
<li>
<code>mol</code>: molecule
</li>
</ul>
</li>
<li>
The Axmol pronunciation: <code>/æksmoʊl/</code>
</li>
<li>
The Axmol slug:
<ul>
<li>Axmol is a fork of Cocos2d-x v4.0</li>
<li>Axmol is an engine with various low level capabilities, like molecules in our real world.</li>
<li>Axmol is a multi-platform engine for desktop, Xbox (UWP) and mobile games.</li>
</ul>
</li>
</ul>
<h2><a id="how-to-contribute"></a>How to contribute</h2>
<ul>
<li>Suggestions, bug fixes, and improvements are highly appreciated!</li>
<li><a href="https://github.com/axmolengine/axmol/blob/d8d3137515a73e5c2395cae04d6b5ef6b1cc6777/CONTRIBUTING.md">Instructions for contributing</a></li>
<li><a href="https://github.com/axmolengine/axmol/blob/dev/AUTHORS.md">Collaborators list</a></li>
</ul>
<h2><a id="how-to-know-more"></a>How to know more</h2>
<ul>
<li>Please <a href="https://github.com/axmolengine/axmol/wiki">visit our Wiki</a></li>
</ul>
<footer class="site-footer">
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
</footer>
</main>
</body>
</html>