OpenComputers Documentation

repository·master-MC1.7.10·Indexed 23 days ago

https://github.com/mightypirates/opencomputers

A Minecraft mod that adds programmable computers and robots using Lua 5.2. This documentation covers the OpenComputers API for mod developers, including how to expose Tile Entities as components via SimpleComponent and Environment interfaces, implementing item drivers, and using the FileSystem API. It also provides guides on setting up the development workspace in IntelliJ IDEA or Eclipse, adding lootable floppy disks, and implementing mod drivers following specific architectural patterns and guidelines.

Tokens
117.8K
Snippets
110
Records
863
Agent score
71%

What's inside OpenComputers

  1. Overview of OpenComputers devices and capabilities

    master-MC1.7.10

    OpenComputers provides a suite of persistent, modular, and highly configurable devices that can be programmed using Lua 5.2.

    Core Device Types

    • Computers: The primary base for systems. They feature modular components and can access components via six faces. Component capacity is limited by the processor level.
    • Servers: Designed for higher complexity. They can connect to more components (both internal and external) using component buses. However, due to the server rack, a server can only access components through a single face of the rack as configured in the server rack interface.
    • Micro-controllers: Highly limited devices. They lack hard disk (HDD) and disk drive slots, meaning OpenOS cannot be installed on them. Instead, they use an EEPROM for specialized, limited-task operating systems.
    • Robots: Mobile computers capable of interacting with the world. Unlike computers, internal components cannot be swapped once built unless the robot is equipped with an upgrade container or a card container. OpenOS can be run on robots via a disk drive (using floppies) or a pre-installed HDD. To completely reconfigure a robot, it must be passed through a disassembler.
    • Drones: A limited version of robots. They have different movement mechanics, fewer inventory slots, and no operating system (they use EEPROM for specific tasks instead).

    Key Concepts

    • Persistence: Computers, servers, robots, and drones are persistent. They maintain their state even when the chunk they are in is unloaded. Tablets are the only exception to this rule.
    • Modularity: Most devices allow for component swapping via their respective interfaces. For robots, use containers to allow hot-swapping of cards or upgrades.
    • Interoperability: Devices can interact with other Minecraft mods for block/entity manipulation via an adapter, or through specific robot or drone upgrades. They support various energy types including Redstone Flux (RF), IndustrialCraft2 EU, Mekanism Joules, Applied Energistics 2, and Factorization charge.
  2. Overview of OpenComputers

    master-MC1.7.10

    OpenComputers is a Minecraft mod that introduces programmable computers and robots.

    Key Features:

    • Lua 5.2 Integration: Computers use Lua 5.2 for programming.
    • Persistence: The computer implementation is fully persistent, meaning programs continue running across game reloads.
    • Licensing: The mod is licensed under the MIT license, and all assets are in the public domain (unless otherwise stated), making it free to use in modpacks.
  3. Browse the OpenComputers block index

    master-MC1.7.10

    The block index provides a categorized overview of all documented blocks in OpenComputers. Note that some blocks may be unavailable depending on the specific recipe settings of your modpack.

    Blocks are categorized into:

    • Computer: Main computing units like cases, microcontrollers, robots, and server racks.
    • Komponenten (Components):
      • Eingabe / Ausgabe (I/O): Input and output devices like keyboards, screens, and hologram projectors.
      • Speicher (Storage): Storage solutions like disk drives and RAID systems.
      • Extensions: Specialized hardware like adapters, geolyzers, motion sensors, redstone I/O, and waypoints.
    • Montage / Druck (Assembly / Printing): Tools for manufacturing such as 3D printers, assemblers, and disassemblers.
    • Netzwerktechnik (Networking): Connectivity tools like cables, net splitters, and relays.
    • Energiemanagement (Power Management): Power-related components like capacitors, chargers, power converters, and power distributors.
  4. Browse documented OpenComputers blocks

    master-MC1.7.10

    The OpenComputers block index provides documentation for various functional blocks used in the mod. These are categorized by their primary function: Computers, Components (Input/Output, Storage, Extensions), Assembly/Printing, Networking, and Power Management.

    Note: Availability of specific blocks may vary depending on the recipe set being used in your modpack. If you are looking for handheld or portable items rather than stationary blocks, consult the item index instead.

  5. Browse OpenComputers blocks

    master-MC1.7.10

    The OpenComputers block index provides a categorized list of all functional blocks available in the mod. Use this index to find specific hardware for computers, components for I/O or storage, networking equipment, and power management tools. Note that availability of certain blocks may vary depending on the recipe set being used in your environment.

    Categories include:

    • Computers: Main computing units like Cases, Microcontrollers, Robots, and Racks.
    • Components: Sub-modules for I/O (Monitors, Keyboards), Data Storage (Disk Drives, RAID), and Extensions (Adapters, Sensors, Redstone controllers).
    • Assembly/Printing: Tools for manufacturing like 3D Printers, Assemblers, and Disassemblers.
    • Networking: Connectivity tools like Cables, Net Splitters, and Relays.
    • Power Management: Energy storage and distribution tools like Capacitors, Chargers, and Power Converters.
  6. Browse the OpenComputers item index

    master-MC1.7.10

    The item index provides documentation for various tools, devices, components, and crafting materials used in OpenComputers. Note that availability of specific items may vary depending on the recipe set being used in your environment.

    Items are categorized into:

    • Tools: Utility items like the Analyzer, Manual, and Remote Terminal.
    • Devices: Standalone hardware such as Drone, Server, and Tablet.
    • Components:
      • Cards: Expansion cards like Graphics Card, Internet Card, and Redstone Card.
      • Upgrades: Functional enhancements like Battery Upgrade, Chunk Loader Upgrade, and Inventory Upgrade.
      • Rack Mountables: Items designed for server racks, including Disk Drive and Terminal Server.
      • Other: Core hardware like CPU, RAM, Hard Disk Drive, and EEPROM.
    • Crafting: Materials and sub-components required for assembly, such as Circuit Board, Microchip, and Transistor.
    • Assembling / Printing: Items used in the manufacturing process, such as Ink Cartridge and various device cases.

    If you are looking for information on blocks rather than items, refer to the block index.

  7. Browse OpenComputers item index

    master-MC1.7.10

    The OpenComputers item index provides a categorized list of all items available in the mod. This index is used to find tools, devices, components, upgrades, and crafting materials.

    Note: Some blocks may be unavailable depending on the specific crafting recipe combinations used in your modpack.

    To find blocks specifically, refer to the Block Index.

  8. Browse OpenComputers item documentation

    master-MC1.7.10

    The OpenComputers item index provides documentation for all items in the mod, categorized by their function. Note that availability of certain items may vary depending on the Recipe Set being used in your modpack.

    Items are organized into the following categories:

    • Werkzeuge (Tools): Specialized tools like the Analyzer, Manual, and Wrench.
    • Geräte (Devices): Main hardware units such as Drones, Servers, and Tablets.
    • Komponenten (Components):
      • Karten (Cards): Expansion cards for various functionalities (e.g., Graphics, Internet, Redstone, WLAN).
      • Upgrades: Specialized modules for devices (e.g., Battery, Chunkloader, Solar Generator, Inventory).
      • Anderes (Other): Core hardware like CPUs, RAM, EEPROM, and Storage (Floppy, HDD).
    • Crafting: Materials and sub-components used to build hardware (e.g., Microchips, Circuit Boards, ALU).
    • Montage / Druck (Assembly / Printing): Consumables and housings used in the assembly process (e.g., Chamelium, Ink Cartridges, Drone Cases).
    • Anderes (Other): Miscellaneous items like Hover Boots.
  9. Browse OpenComputers blocks index

    master-MC1.7.10

    This index provides a categorized overview of all blocks available in the OpenComputers mod. Blocks are categorized by their primary function: Computers, Components (Input/Output, Storage, and Expansion), Assembly/Printing, Networking, and Power Management.

    Note: Availability of certain blocks may vary depending on the specific crafting recipes used in your modpack.

  10. What is an EEPROM and how is it used

    master-MC1.7.10

    An EEPROM is a storage component used to hold the code required to initialize a computer during its startup sequence. Data is stored as an array of bytes. The interpretation of these bytes depends on the specific CPU architecture being used:

    • Lua architectures: Typically contains a small script that searches for file systems and runs an initialization script.
    • Other architectures: May contain raw machine code.

    EEPROMs can be programmed for specialized hardware, such as drones or microcontrollers.