🛤️ Path Guide

July 25, 2025 · View on GitHub

Lua API Difficulty Version

🚀 Quick Start Guide for handling file paths with LuaDoTheWorld

📋 What You'll Learn

  • ✅ How to extract file name, directory, and extension
  • ✅ How to get subdirectories from a path
  • ✅ How to change directory, name, or extension
  • ✅ How to insert or replace directories in a path

🛠️ Prerequisites

  • LuaDoTheWorld installed and required in your script

🏷️ Basic Path Extraction

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
print("name", path.get_name())        -- c.txt
print("dir", path.get_dir())          -- a/b
print("extension", path.get_extension()) -- txt

📂 Extracting Subdirectories

You can extract subdirectories by index. Use negative numbers for counting from the end (-1 is last, -2 is second last).

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
local sub_dirs = path.get_sub_dirs_from_index(1, -1)
print(sub_dirs) -- b

✏️ Changing Path Parts

Set Directory

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.set_dir("test")
print(path.get_full_path()) -- test/c.txt

Set Name

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.set_name("d.txt")
print(path.get_full_path()) -- a/b/d.txt

Set Extension

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.set_extension("py")
print(path.get_full_path()) -- a/b/c.py

➕ Inserting Directories

Insert After Directory

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.insert_dir_after("a", "inserted_dir")
print(path.get_full_path()) -- a/inserted_dir/b/c.txt

Insert Before Directory

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.insert_dir_before("a", "inserted_dir")
print(path.get_full_path()) -- inserted_dir/a/b/c.txt

Insert at Index

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.insert_dir_at_index(1, "inserted_dir")
print(path.get_full_path()) -- a/inserted_dir/b/c.txt

🔄 Replacing Directories

local dtw = require("luaDoTheWorld/luaDoTheWorld")
local path = dtw.newPath("a/b/c.txt")
path.replace_dirs("a", "inserted_dir")
print(path.get_full_path()) -- inserted_dir/b/c.txt

📚 Quick Reference

FunctionWhat it doesExample
dtw.newPath(path)Create a new path objectdtw.newPath("a/b/c.txt")
path.get_name()Get file namepath.get_name()
path.get_dir()Get directorypath.get_dir()
path.get_extension()Get extensionpath.get_extension()
path.get_sub_dirs_from_index(start, end)Get subdirectoriespath.get_sub_dirs_from_index(1, -1)
path.set_dir(dir)Set directorypath.set_dir("test")
path.set_name(name)Set file namepath.set_name("d.txt")
path.set_extension(ext)Set extensionpath.set_extension("py")
path.insert_dir_after(target, dir)Insert dir afterpath.insert_dir_after("a", "inserted_dir")
path.insert_dir_before(target, dir)Insert dir beforepath.insert_dir_before("a", "inserted_dir")
path.insert_dir_at_index(idx, dir)Insert dir at indexpath.insert_dir_at_index(1, "inserted_dir")
path.replace_dirs(target, dir)Replace dirpath.replace_dirs("a", "inserted_dir")

🆘 Need Help?

  • 📖 Check the main SDK documentation
  • 🔍 Look at other example scripts in the SDK
  • 🐛 Report issues on our GitHub repository

Footer