script-submit.html

---

layout: catalogue
title: Submit a lua script

---

<div class="row">
    <div class="col">
        <h2 class="display-4">Steps</h2>
        <br>

        <ol>
            <li>In order to share your lua scripts you need to add the topic azerothcore-lua.</li>
            <li>This avoids having to Fork the Catalog and wait to see your share on the catalog.</li>
        </ol>
        <div class="alert alert-info"><p>Warning, if you are not the author of the scripts, you must report it!</p><p>Do not attribute what is not yours.</p></div>

        <h2 class="display-4">How to add a topic to my repositories</h2>
        <ol>
            <h3>Step 1</h3>
            <a href="https://zupimages.net/up/20/22/47j2.png"><img src="https://zupimages.net/up/20/22/47j2.png" style="max-width: 50%;height: auto;"/></a>
            <h3>Step 2</h3>
            <a href="https://zupimages.net/up/20/22/kn0r.png"><img src="https://zupimages.net/up/20/22/kn0r.png" style="max-width: 50%;height: auto;"/></a>
        </ol>
    </div>
</div>

<div class="row">
    <div class="col">
        <h2 class="display-4">Information requested</h2>
        <br>

        <h4>Script info</h4>
        <ul>
            <li><b>Name:</b> <i>name of your lua script.</i></li>
            <li><b>Author:</b> <i>username of the original author (in case it's forked into an organization).</i></li>
            <li><b>Repository:</b> <i>link to the GitHub repository.</i></li>
            <li><b>Download:</b> <i>link to download the sources as .zip (take it from GitHub).</i></li>
            <li><b>License:</b> <i>license used to release the code.</i></li>
        </ul>

        <h4>Script integration</h4>

        <ul>
            <li><b>Includes configuration?:</b> <i>specify if your lua script uses a configuration file (myElunaScriptConf.ext), and if the file is copied automatically by your lua script or manually by the user.</i></li>
            <li><b>Includes SQL patches?:</b> <i>specify if your lna script patches the databases. If yes, indicate which databases are affected and if the patches have to be applied manually by the user.</i><b><p>The database to be assigned must never be an AzerothCore database.<br>Please create an independent database in order to avoid pollution of existing databases.</p></b></li>
        </ul>

        <h4>Description</h4>

        <p>Give a complete description of what does the lua script and how it does it.</p>
    </div>
</div>
<div class="row">
    <div class="col">
        <h2 class="display-4">Optional / Recommended</h2>
        <br>

        <ul>
            <li>Add a <code>README.md</code> in the root folder with a complete description of your lua script. It will be shown in the details page of the catalogue.</li>
            <li>Add an <code>icon.png</code> in the root folder. It will be shown in the lua script list and details page of the catalogue.</li>
            <li>Use the <code>db_assembler</code> to include your SQL patches.</li>
            <li>Follow best practices from the skeleton-lua (.gitattributes, .gitkeep etc...)</li>
            <li>Give the user the biggest amount of options for configuration possible. It reduces the need to modify the code because "something doesn't work as I would like to".</li>
            <li>Use the GNU Affero General Public License v3.0.</li>
        </ul>
    </div>
</div>