Git Product home page Git Product logo

aomcodereference's Introduction

AoM Code Reference

What's this?

This project uses a combination of the Java programming language and the JavaDoc tool to produce a reference for internal commands used by the game Age of Mythology, its expansion pack and the extended edition.

Where can I find the reference?

Right here: https://mythicfreak.github.io/aomcodereference/

I found some inconsistencies in your reference!

That's very possible. I pulled this reference together from many different sources in addition to my own experience as an XS scripter, so small errors are no doubt present. On top of that, this project has been a work in progress for a couple of years now, and it will hopefully continue to be updated for the foreseeable future.

In any case, pull requests with bugfixes or new even additions are always welcome!

How does this work?

This project contains java code with function stubs that represent the internal commands used by AoM. Note that these functions merely offer an interface, there is no actual implementation of the code. The added value of this project is in the javadoc annotations of every function and variable. This information can automatically be extracted from the code by a tool (JavaDoc) and converted to HTML reference pages. Those are the pages we are interested in, and which are hosted here on GitHub.

Which JavaDoc options do you use?

  • title: "AoM Code Reference"
  • public level code
  • generate complete index, not separated per letter
  • extra options:
    • -noqualifier all
    • -taglet aom.scripting.taglet.SyncTaglet
    • -taglet aom.scripting.taglet.LocalTaglet
    • -taglet aom.scripting.taglet.SinglePlayerTaglet
    • -taglet aom.scripting.taglet.EditorTaglet
    • -tagletpath "<your_path_to_project_folder>\bin"
    • -tag return
    • -tag throws
    • -tag note:a:"Note"
    • -tag see
    • -tag example:a:"Example"

aomcodereference's People

Contributors

milkmanmatty avatar mythicfreak avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.