← Back to Oyun

Oyun Game Maker Documentation

Everything you need to create, test, and export 3D simulation games.

Creating a Project

To create a new game, click + New Project from the Dashboard. You will see a gallery of 102 business templates organized by category. Each template pre-populates your scene with appropriate objects, zones, and layout.

  1. Enter a Project Name at the top of the page (or let it auto-fill from the template).
  2. Browse the template categories: Retail, Food & Drink, Services, Healthcare, Entertainment, and more.
  3. Click Use Template on any card. Your project is created instantly and you land in the Project Hub.
  4. Alternatively, scroll to the bottom and choose Blank Project to start with an empty scene.
Tip
You can duplicate any project from the Dashboard to experiment without risking your main build.

Using Templates

Templates are pre-configured scene layouts that include objects, spawn zones, shelving, counters, and decoration suited to a specific business type. When you select a template, the Auto Maker system places objects intelligently based on the business type.

After generation, everything is fully editable. You can move, delete, or replace any object. Templates simply give you a head start so you are not staring at an empty scene.

The Project Hub

The Project Hub is your central command for each game. It shows a step-by-step guide to building your game and provides quick-access buttons to every tool.

3D Viewport Controls

The 3D viewport is powered by Three.js and provides a fully interactive scene editing experience.

Tip
Double-click any object to focus and zoom into it instantly.

Object Library (1,259 Items)

The Object Library panel on the left side of the editor contains 1,259 placeable objects across 35 categories. Click any object to place it at the scene center, then use the transform tools to position it.

Objects include full 3D geometry generated procedurally with Three.js. Each object has customizable properties such as color, size, and interaction type accessible through the Properties Panel.

See Object Categories below for a full breakdown.

Auto Maker (102 Templates)

Auto Maker is the one-click scene generation system. It reads your project's simulation type and template, then auto-populates the scene with appropriate objects, zones, and layout.

Scene Hierarchy

The Scene Hierarchy panel (top-right of the editor) shows every object in your scene as a tree. Objects can be grouped, renamed, and re-ordered. Click an item to select it in the viewport; drag items to re-parent them under groups.

Properties Panel

When you select an object, the Properties Panel (right side) shows its transform (position, rotation, scale), color, custom properties, interaction settings, and zone assignments.

Character Studio

Character Studio is a dedicated page for creating and managing your game's NPCs. Access it from the Project Hub or the editor sidebar. Each character has a 3D preview, customizable appearance, assigned role, and behavior configuration.

Appearance Customization

Each character's appearance can be configured with skin tone, hair style and color, outfit, and accessories. The built-in system provides a range of preset options; Ready Player Me integration allows full custom avatars.

Roles & Behaviors

Characters can be assigned roles that determine their AI behavior in play mode:

NPC Schedules

NPCs can be given daily schedules that determine where they go and what they do at different times of day. Schedules are defined per-hour and support activities like working, eating, sleeping, and socializing. The Day/Night system drives NPC schedule transitions automatically.

Economy & Inventory

Every simulation game needs an economy. Oyun provides a built-in economy engine that handles money, pricing, purchases, inventory, and transactions.

Quests & Achievements

The Quest Editor lets you create multi-step quest chains with objectives, rewards, and branching paths.

Dialogues

The Dialogue System provides branching conversations with typewriter-style text rendering. Dialogues are created in the editor and assigned to NPC characters.

Visual Scripting

For custom game logic beyond the built-in systems, Oyun provides a Behavior Tree editor. This visual scripting tool lets you create complex AI and event logic without code.

Weather & Day/Night

Oyun includes a full weather system and day/night cycle that affect gameplay and visuals.

World Builder (Multi-Map)

The World Builder lets you create games with multiple interconnected maps. Each map is a separate scene that players can travel between.

Terrain Editor

For outdoor scenes, the Terrain Editor provides heightmap-based terrain with painting tools.

Spline / Path Tools

Spline tools let you create roads, sidewalks, rivers, fences, and other path-based objects.

Lighting

Oyun supports multiple light types to create atmosphere in your scenes.

Audio System (18 Procedural Sounds)

Oyun generates audio procedurally using the Web Audio API. No audio files needed. The system includes 18 built-in sounds:

SoundTriggerDescription
Cash RegisterPurchase completeClassic "ka-ching" sound
Door BellCustomer enters/exitsChime when doors open
Coin DropMoney receivedMetallic coin sound
Item PickupPlayer picks up itemShort pop/whoosh
Item PlacePlayer places itemSoft thud
Button ClickUI interactionSubtle click
Level UpAchievement/levelTriumphant jingle
Quest CompleteQuest finishedFanfare sound
Error / DenyInvalid actionBuzzer sound
Cooking SizzleKitchen activityFrying pan sizzle
Cooking ChopFood prepKnife chopping
HealingMedical treatmentSoft healing tone
Animal SoundAnimal interactionVarious animal calls
FootstepsPlayer walkingSurface-dependent steps
Ambient WindOutdoor scenesGentle wind loop
RainRain weatherRain hitting surfaces
ThunderStorm weatherDistant thunder rumble
NotificationUI notificationGentle ping

Particle Effects (20 Presets)

The particle system provides 20 ready-made presets for common game effects:

Post-Processing (9 Shaders)

Post-processing shaders are applied to the final rendered image for visual polish:

Water Shader

The water shader creates realistic water surfaces for pools, rivers, oceans, and ponds. Features include reflections, refraction, wave animation, foam at edges, and configurable color and transparency.

Play Mode Controls

Press Space in the editor to enter Play Mode. Your camera switches to a first/third-person player controller and the game systems activate.

Debug Console Commands

Press ` (backtick) during Play Mode to open the Debug Console. Type commands and press Enter. The console supports autocomplete (Tab key) and command history (Up/Down arrows).

CommandArgumentsDescription
helpShow all available commands
clearClear console output
give_money[amount]Add money (default: 1000)
set_money<amount>Set money to exact amount
give_item<id> [quantity]Add item to inventory
set_time<hour>Set time of day (0-23)
set_day<day>Set current day number
skip_daySkip to next day
timescale<multiplier>Set time speed (e.g., 2 = double speed)
teleport<x> <y> <z>Teleport player to coordinates
noclipToggle noclip (fly through walls)
speed<multiplier>Set player speed multiplier
godToggle god mode (invincibility)
spawn_npc[type]Spawn an NPC of given type
spawn_customerSpawn a customer NPC
weather<type>Set weather (clear, rain, snow, fog, storm)
complete_quest<id>Force-complete a quest
unlock_achievement<id>Unlock an achievement
fpsShow render stats (draw calls, triangles, textures)
wireframeToggle wireframe rendering
navmeshToggle navmesh visualization overlay
saveQuick save the game
screenshotTake and download a screenshot
reload_sceneReload the current scene

Testing Checklist

Before exporting, verify each of the following in Play Mode:

  1. Player can move through the entire scene without getting stuck on geometry.
  2. All interactable objects respond to the E key.
  3. Customers spawn, browse, pick up items, go to checkout, and leave.
  4. Employees perform their assigned tasks (stocking, cashier, greeting).
  5. Economy works: buying supplies, selling to customers, money balance updates.
  6. Dialogues display correctly with all branches reachable.
  7. Quests can be started, progressed, and completed.
  8. Achievements unlock at the correct triggers.
  9. Day/night cycle transitions smoothly. NPC schedules change with time.
  10. Weather effects render correctly and transitions are smooth.
  11. Audio plays for interactions (cash register, door bell, etc.).
  12. No objects floating above or clipping through the floor.
  13. Performance stays above 30 FPS (use the fps debug command).

Game Settings

Access Game Settings from the Project Hub or the gear icon in the editor. Configure your game's metadata before export:

Windows / Mac / Linux Export

Oyun exports standalone desktop applications using Electron. The exported game includes all assets, scenes, and game logic bundled into a single executable.

  1. Go to Game Settings and ensure all metadata is filled in.
  2. Click Export and choose your target platform(s).
  3. The build system compiles your game. Download the build when complete.
  4. Test the exported build on the target platform before publishing.

Web / HTML5 Export

Games can also be exported as HTML5 web applications, playable in any modern browser. Web exports are great for sharing demos, hosting on itch.io, or embedding on websites.

Steam Integration

Oyun supports full Steam integration for published games:

Note
You need a Steamworks developer account ($100 fee from Valve) to publish on Steam. Oyun handles the technical integration; you handle the business setup.

Keyboard Shortcuts

General

ShortcutAction
Ctrl+SSave scene
Ctrl+ZUndo
Ctrl+Shift+ZRedo
DeleteRemove selected object
?Show help / keyboard shortcuts overlay

Transform

ShortcutAction
GMove (grab) selected object
RRotate selected object
SScale selected object
FFocus camera on selected object

Camera

ShortcutAction
Alt+1Front view
Alt+3Side view
Alt+7Top view
Scroll wheelZoom in / out
Middle-click dragPan view
Right-click dragOrbit camera

Selection

ShortcutAction
ClickSelect object
Shift+ClickMulti-select (add to selection)
Ctrl+ASelect all objects
Ctrl+DDuplicate selected
Ctrl+CCopy selected
Ctrl+VPaste
Ctrl+GGroup selected objects

Play Mode

ShortcutAction
SpaceStart / stop Play Mode
WASDMove player
EInteract
EscPause game
`Open Debug Console
TabQuest Log
JQuest Log (alternate)
VToggle camera (first/third person)
HToggle controls help overlay

Other

ShortcutAction
1 - 4Quick place primitives (box, sphere, cylinder, plane)

All Business Types (102 Templates)

Oyun includes 102 pre-built business templates across 11 categories. Each template auto-generates a complete scene with appropriate objects, zones, and layout.

Retail (15)

TemplateDescription
Grocery StoreSupermarket with aisles, products, and checkout lanes
Clothing StoreFashion boutique with racks, fitting rooms, and checkout
Electronics StoreSell gadgets, phones, and TVs
BakeryFresh bread and pastries with display cases
Convenience StoreSmall corner shop with snacks and essentials
Pet StoreAnimals, food, supplies, and grooming
Toy StoreShelves of toys, play area, and checkout
BookstoreBookshelves, reading corner, and cafe
Flower ShopBouquets, potted plants, and arrangements
Jewelry StoreDisplay cases, luxury items, and security
Furniture StoreShowroom with bedroom, living room, and dining sets
Hardware StoreTools, lumber, paint, and plumbing supplies
PharmacyPrescription counter, shelves, and health products
Sports StoreEquipment, shoes, jerseys, and fitness gear
Thrift StoreRacks of clothes, books, electronics, and furniture

Food & Drink (9)

TemplateDescription
Coffee ShopCozy cafe with counter service and seating
Fast Food RestaurantBurgers and fries with kitchen, counter, and drive-thru
Fine DiningElegant restaurant with table service, bar, and kitchen
Pizza PlaceMake and serve pizza with oven, counter, and dining area
Ice Cream ShopFreezer displays, toppings, and seating
Sushi RestaurantConveyor belt, sushi bar, and tatami rooms
Food TruckMobile kitchen, serving window, and street food
Bar / PubBar counter, taps, pool table, and booths
Juice BarBlenders, fresh fruit, and smoothie bar

Services (7)

TemplateDescription
Barber ShopHaircuts, shaves, and styling chairs
Beauty SalonNail art, hair, and makeup stations
LaundromatWashing machines, dryers, and folding area
Car WashDrive-through wash and detailing bay
Gas StationFuel pumps, mini mart, and car repair
Auto Repair ShopGarage bays, tools, and waiting room
Car DealershipShowroom floor, test drive area, and offices

Healthcare (5)

TemplateDescription
HospitalMedical facility with exam rooms, pharmacy, and ER
Medical ClinicReception, waiting room, and exam rooms
Dental OfficeDental chairs, X-ray room, and reception
Veterinary ClinicExam rooms, kennels, and waiting area
PharmacyPrescription counter, shelves, and health products

Entertainment & Fitness (5)

TemplateDescription
Gym / Fitness CenterWeights, treadmills, and locker rooms
Movie TheaterScreening rooms, ticket booth, and concessions
ArcadeGame machines, prize counter, and neon lights
Bowling AlleyLanes, shoe rental, and snack bar
LibraryBookshelves, study desks, and computer area

Public & Government (5)

TemplateDescription
BankTeller windows, vault, offices, and ATMs
Police StationFront desk, holding cells, and offices
Fire StationTruck bays, living quarters, and training
SchoolClassrooms, cafeteria, gym, and playground
Daycare CenterPlay areas, nap room, and outdoor playground

Hospitality (2)

TemplateDescription
HotelRooms, lobby, restaurant, and pool
MotelSmall roadside motel with basic rooms

Agriculture (2)

TemplateDescription
Small FarmCrop plots, barn, animals, and sell stand
Large FarmBig fields, silo, multiple barns, and greenhouse

Animals & Nature (27)

TemplateDescription
ZooAnimal exhibits, gift shop, food court, ticket booth
AquariumFish tanks, touch pools, gift shop, cafe
Animal ShelterKennels, adoption center, medical room
Horse StableStalls, riding arena, tack room, hay storage
Dog Grooming SalonGrooming tables, bath stations, drying area
Bird SanctuaryAviaries, feeding stations, visitor path
Fish MarketIce displays, filleting station, scales, coolers
Dairy FarmCows, milking parlor, cheese making, milk storage
Poultry FarmChicken coops, egg collection, feed storage
Pig FarmPig pens, feeding area, processing
Sheep RanchPastures, shearing shed, wool processing
Horse RanchStables, riding arena, paddocks, tack room
Fish Farm / HatcheryFish ponds, tanks, feeding, processing
Bee Farm / ApiaryBeehives, honey extraction, bottling
Vineyard / WineryGrape vines, wine cellar, tasting room
Fruit OrchardApple/orange trees, picking baskets, farm stand
Dog Breeding KennelDog runs, whelping room, grooming, training
Cat CafeCafe with cats roaming, cat trees, food counter
Safari ParkDrive-through exhibits, viewing platforms, gift shop
Petting ZooOpen enclosures, feeding stations, hand wash, gift shop
Wildlife Rescue CenterRehabilitation cages, medical room, education center
Reptile HouseTerrariums, heat lamps, viewing area
Butterfly GardenEnclosed garden, nectar plants, education center
Marine ParkDolphin pool, aquarium tunnel, show arena, gift shop
Dog Training SchoolTraining field, obstacle course, classroom
Animal HospitalSurgery room, recovery kennels, pharmacy, X-ray
InsectariumDisplay cases, live exhibits, education room

Outdoor & Recreation (7)

TemplateDescription
Water ParkPools, water slides, changing rooms, snack bar
Amusement ParkRides, ticket booth, food stalls, games
CampgroundTent sites, cabins, fire pits, restrooms, store
Ski ResortLodge, equipment rental, chairlift, restaurant
Golf ClubClubhouse, pro shop, driving range, restaurant
Ice Skating RinkRink, skate rental, warming area, snack bar
Swimming Pool CenterPool, locker rooms, lifeguard station, cafe

Creative & Education (6)

TemplateDescription
Art GalleryExhibition rooms, gift shop, studio space
Music StudioRecording booths, mixing room, instrument storage
Dance StudioDance floor, mirrors, changing rooms, reception
Pottery StudioPottery wheels, kiln, shelves, glazing area
Photo StudioBackdrops, lighting rigs, editing room, reception
Cooking SchoolTeaching kitchen, demo area, ingredient storage

Transportation (4)

TemplateDescription
Airport TerminalCheck-in counters, security, gates, shops
Train StationPlatforms, ticket office, waiting room, shops
Bus TerminalPlatforms, ticket booth, waiting area, kiosks
Marina / Boat DockBoat slips, office, bait shop, fuel dock

Niche & Specialty (8)

TemplateDescription
Tattoo ParlorTattoo stations, design wall, sterilization, waiting
Escape RoomThemed rooms, lobby, control room, reception
Wedding VenueCeremony hall, reception area, dressing rooms
Funeral HomeChapel, viewing rooms, office, arrangement room
Pawn ShopDisplay cases, appraisal counter, storage vault
Recycling CenterSorting bins, weigh station, compactor, office
Post OfficeService counter, mailboxes, sorting area, packages
Spa & WellnessMassage rooms, sauna, pool, relaxation lounge

Industrial (1) + Other (1)

TemplateDescription
WarehouseShelving racks, loading dock, and forklifts
Blank ProjectStart from scratch with an empty scene

Object Categories (1,259 Items across 35 Categories)

The Object Library contains 1,259 unique objects organized into the following categories:

CategoryExamples
FurnitureTables, chairs, sofas, beds, shelves, bookcases, cabinets, desks, wardrobes
NatureTrees, bushes, flowers, rocks, grass, logs, stumps, mushrooms
ArchitectureWalls, floors, doors, windows, stairs, roofs, fences, pillars
Shop & BusinessCounters, shelving, display cases, registers, shopping carts, mannequins
Restaurant & KitchenStoves, ovens, fridges, prep tables, plates, glasses, kitchen counters
Hospital & MedicalHospital beds, exam tables, wheelchairs, IV stands, X-ray machines
FarmCrop plots, fences, barns, silos, troughs, hay bales, sell stands
Outdoor & UrbanBenches, street lights, trash cans, mailboxes, hydrants, bollards, signs
VehiclesCars, trucks, buses, bicycles, boats, forklifts
Lighting & FXLamps, spotlights, neon signs, candles, torches
PrimitivesBox, sphere, cylinder, plane, cone, torus
Electronics & TechnologyTVs, monitors, phones, printers, servers, arcade machines, ATMs
Bathroom & PlumbingToilets, sinks, bathtubs, showers, mirrors, towel racks
Office & WorkspaceDesks, office chairs, filing cabinets, whiteboards, cubicles
Sports & FitnessTreadmills, dumbbells, benches, yoga mats, basketball hoops
Vehicles & TransportCars, buses, trains, boats, helicopters, parking barriers
Food & ProductsBread, milk, cans, bottles, fruits, vegetables, packaged goods
Clothing & AccessoriesShirts, pants, shoes, hats, jewelry, mannequins, racks
Containers & StorageBoxes, crates, barrels, pallets, dumpsters, lockers
Decoration & ArtPaintings, sculptures, vases, rugs, curtains, trophies
Tools & EquipmentHammers, saws, drills, ladders, wheelbarrows, toolboxes
Music & EntertainmentGuitars, pianos, drums, speakers, microphones, jukeboxes
Seasonal & HolidayChristmas trees, pumpkins, easter eggs, fireworks, snowmen
Animals - FarmCows, pigs, chickens, sheep, goats, horses, donkeys
Animals - DogsLabrador, poodle, bulldog, husky, corgi, dalmatian and more
Animals - CatsTabby, siamese, persian, black cat, calico and more
Animals - BirdsParrot, eagle, owl, penguin, flamingo, robin and more
Animals - Fish & AquaticGoldfish, clownfish, shark, whale, dolphin, jellyfish
Animals - ReptilesLizard, snake, turtle, crocodile, chameleon, iguana
Animals - Zoo & ExoticLion, elephant, giraffe, zebra, panda, gorilla, tiger
Animals - Small PetsHamster, rabbit, guinea pig, ferret, chinchilla, hedgehog
Animals - InsectsButterfly, bee, ladybug, ant, dragonfly, spider
Animals - MythicalDragon, unicorn, phoenix, griffin, pegasus
Animals - DinosaursT-Rex, triceratops, velociraptor, brontosaurus, pterodactyl
Animals - MarineWhale, dolphin, seal, walrus, sea turtle, octopus

Frequently Asked Questions

Is Oyun free?

Oyun is free to use for creating games. You can build, test, and export projects at no cost. Steam publishing requires a separate Steamworks developer account ($100 from Valve).

Do I need to know how to code?

No. Oyun is designed for non-programmers. All game logic is configured through visual editors, templates, and property panels. The Behavior Tree editor provides visual scripting for advanced users.

What game engines does Oyun use?

Oyun uses Three.js for 3D rendering in the browser, Laravel for the backend, and Electron for desktop exports. All geometry is generated procedurally.

Can I import my own 3D models?

Yes. Oyun supports importing models via Sketchfab integration. You can search and import free models directly from the editor. Custom GLTF/GLB files can also be uploaded.

How many objects can my scene hold?

There is no hard limit, but performance depends on the target hardware. Scenes with 500-1000 objects run smoothly on most modern computers. Use the fps debug command to monitor performance.

Can I make multiplayer games?

Oyun includes an experimental multiplayer system using Game Rooms. Players can create or join rooms and share the same scene in real-time. This feature is still in active development.

What platforms can I export to?

Windows, macOS, Linux (via Electron), and Web/HTML5. Mobile export is on the roadmap.

How do I sell my game on Steam?

Create a Steamworks developer account, set up your store page on Steamworks, export your game from Oyun as a desktop build, upload using Steamworks tools, and submit for review. Oyun handles Steam achievements and cloud save integration automatically.

Can I use Oyun commercially?

Yes. Games created with Oyun are yours. You retain full ownership and can sell them on Steam, itch.io, or anywhere else.

Where is my data saved?

Projects are saved to the Oyun server database. Scene data, assets, and settings are stored per-project. You can export your project at any time.

Oyun Game Maker Documentation · Built with Laravel & Three.js