2024-06-08 15:33:03 +02:00
|
|
|
<!--
|
|
|
|
|
STAROPENSOURCE ENGINE SOURCE FILE
|
|
|
|
|
Copyright (c) 2024 The StarOpenSource Engine Contributors
|
|
|
|
|
Licensed under the GNU Affero General Public License v3
|
|
|
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU Affero General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
License, or (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU Affero General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
-->
|
|
|
|
|
<body>
|
2024-06-08 17:07:58 +02:00
|
|
|
<p>Welcome to the sos!engine API documentation!<br/>
|
2024-06-08 15:33:03 +02:00
|
|
|
You are currently in the documentation for the <b>base</b> subsystem, the core of the engine.</p>
|
|
|
|
|
<p>The most interesting parts for developers wanting to use the engine are:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>{@link de.staropensource.sosengine.base.Engine} (main engine object)</li>
|
|
|
|
|
<li>{@link de.staropensource.sosengine.base.EngineConfiguration} (engine configuration)</li>
|
|
|
|
|
<li>stuff in {@link de.staropensource.sosengine.base.utility}</li>
|
|
|
|
|
<li>{@link de.staropensource.sosengine.base.classes.Placeholder} (for implementing custom placeholders)</li>
|
|
|
|
|
<li>{@link de.staropensource.sosengine.base.utility.PlaceholderEngine} (for adding those custom placeholders)</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</body>
|
